Open buffers by full name, reopen recently closed buffers, open layout buffers.
Author: Simmo Saan
— Version: 0.3
— License: GPL-3.0-or-later
For WeeChat ≥ 1.0.
Tags: buffer, py2, py3
Added: 2019-10-20
— Updated: 2021-11-06
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 | # -*- coding: utf-8 -*- # # Copyright (c) 2019 by Simmo Saan <simmo.saan@gmail.com> # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. # # # History: # # 2021-11-06, Sébastien Helleu <flashcode@flashtux.org> # version 0.3: make script compatible with WeeChat >= 3.4 # (new parameters in function hdata_search) # 2019-10-20, Simmo Saan <simmo.saan@gmail.com> # version 0.2: improve script description # 2019-10-18, Simmo Saan <simmo.saan@gmail.com> # version 0.1: initial script # """ Open buffers by full name, reopen closed recently closed buffers, open layout buffers """ # Adding handler for other full names in this script (only if necessary) or other scripts (preferred): # # def buffer_open_full_name_cb(data, signal, hashtable): # full_name = hashtable["full_name"] # noswitch = bool(int(hashtable.get("noswitch", "0"))) # # if full_name == "my.buffer.full.name": # # open my.buffer.full.name, considering noswitch if possible # return weechat.WEECHAT_RC_OK_EAT # prevent other callbacks from handling this full name # # return weechat.WEECHAT_RC_OK # let other callbacks handle this full name # # weechat.hook_hsignal("buffer_open_full_name", "buffer_open_full_name_cb", "") from __future__ import print_function SCRIPT_NAME = "buffer_open" SCRIPT_AUTHOR = "Simmo Saan <simmo.saan@gmail.com>" SCRIPT_VERSION = "0.3" SCRIPT_LICENSE = "GPL3" SCRIPT_DESC = "Open buffers by full name, reopen closed recently closed buffers, open layout buffers" SCRIPT_REPO = "https://github.com/sim642/buffer_open" SCRIPT_COMMAND = SCRIPT_NAME IMPORT_OK = True try: import weechat except ImportError: print("This script must be run under WeeChat.") print("Get WeeChat now at: https://weechat.org/") IMPORT_OK = False import re import collections SETTINGS = { "layout_apply": ( "off", "open closed layout buffers on /layout apply" ), "max_closed": ( "10", "maximum number of closed buffers to remember" ) } def log(string): weechat.prnt("", "{}: {}".format(SCRIPT_NAME, string)) def error(string): weechat.prnt("", "{}{}: {}".format(weechat.prefix("error"), SCRIPT_NAME, string)) def command_plugin(plugin, command): weechat.command("", "/command {} {}".format(plugin, command)) def buffer_open_full_name_opened_cb(data, signal, hashtable): full_name = hashtable["full_name"] buffer = weechat.buffer_search("==", full_name) if buffer: # already open, do nothing return weechat.WEECHAT_RC_OK_EAT return weechat.WEECHAT_RC_OK def buffer_open_full_name_unhandled_cb(data, signal, hashtable): full_name = hashtable["full_name"] error("no handler for opening buffer {}".format(full_name)) return weechat.WEECHAT_RC_OK TABLE = { # "full_name": ("plugin", "command"), "core.secured_data": ("core", "/secure"), "core.color": ("core", "/color"), "core.weechat": ("core", ""), # do nothing because always open "fset.fset": ("fset", "/fset"), "irc.irc_raw": ("irc", "/server raw"), "relay.relay.list": ("relay", "/relay"), "relay.relay_raw": ("relay", "/relay raw"), "script.scripts": ("script", "/script"), "trigger.monitor": ("trigger", "/trigger monitor"), "xfer.xfer.list": ("xfer", "/xfer"), # TODO: xfer DCC chat buffer } def buffer_open_full_name_table_cb(data, signal, hashtable): full_name = hashtable["full_name"] if full_name in TABLE: plugin, command = TABLE[full_name] command_plugin(plugin, command) return weechat.WEECHAT_RC_OK_EAT return weechat.WEECHAT_RC_OK IRC_SERVER_RE = re.compile(r"^irc\.server\.(.+)$") IRC_BUFFER_RE = re.compile(r"^irc\.([^.]+)\.(.+)$") irc_server_connected_opens = collections.defaultdict(set) def irc_server_open(server, noswitch): command_plugin("irc", "/connect {}".format(server)) # /connect doesn't have -noswitch def hdata_search(hdata, pointer, expr, name): weechat_version = int(weechat.info_get("version_number", "") or 0) if weechat_version >= 0x03040000: return weechat.hdata_search( hdata, pointer, expr + " == ${name}", {}, {"name": name}, {}, 1, ) return weechat.hdata_search(hdata, pointer, expr + " == " + name, 1) def irc_buffer_open(server, name, noswitch): hdata_irc_server = weechat.hdata_get("irc_server") irc_servers = weechat.hdata_get_list(hdata_irc_server, "irc_servers") irc_server = hdata_search(hdata_irc_server, irc_servers, "${irc_server.name}", server) chantypes = weechat.hdata_string(hdata_irc_server, irc_server, "chantypes") is_channel = name[0] in chantypes noswitch_flag = "-noswitch " if noswitch else "" if is_channel: command_plugin("irc", "/join {}-server {} {}".format(noswitch_flag, server, name)) else: command_plugin("irc", "/query {}-server {} {}".format(noswitch_flag, server, name)) def irc_server_connected_cb(data, signal, server): for name, noswitch in irc_server_connected_opens[server]: irc_buffer_open(server, name, noswitch) irc_server_connected_opens[server] = set() return weechat.WEECHAT_RC_OK def buffer_open_full_name_irc_cb(data, signal, hashtable): full_name = hashtable["full_name"] noswitch = bool(int(hashtable.get("noswitch", "0"))) m = IRC_SERVER_RE.match(full_name) if m: server = m.group(1) irc_server_open(server, noswitch) return weechat.WEECHAT_RC_OK_EAT m = IRC_BUFFER_RE.match(full_name) if m: server = m.group(1) name = m.group(2) hdata_irc_server = weechat.hdata_get("irc_server") irc_servers = weechat.hdata_get_list(hdata_irc_server, "irc_servers") irc_server = hdata_search(hdata_irc_server, irc_servers, "${irc_server.name} == ", server) if irc_server: is_connected = bool(weechat.hdata_integer(hdata_irc_server, irc_server, "is_connected")) is_connecting = bool(weechat.hdata_pointer(hdata_irc_server, irc_server, "hook_connect")) if is_connected: irc_buffer_open(server, name, noswitch) else: irc_server_connected_opens[server].add((name, noswitch)) if not is_connecting: irc_server_open(server, noswitch) else: error("unknown server {}".format(server)) return weechat.WEECHAT_RC_OK_EAT return weechat.WEECHAT_RC_OK def buffer_open_full_name(full_name, noswitch=None): hashtable = { "full_name": full_name } if noswitch is not None: hashtable["noswitch"] = str(int(noswitch)) # must be str for API weechat.hook_hsignal_send("buffer_open_full_name", hashtable) def command_cb(data, buffer, args): args = args.split() if len(args) >= 1 and args[0] == "closed": if len(args) >= 2 and args[1] == "-list": if buffer_closed_stack: weechat.prnt("", "closed buffers (latest first):") for full_name in reversed(buffer_closed_stack): weechat.prnt("", " {}".format(full_name)) else: weechat.prnt("", "no known closed buffers") else: if buffer_closed_stack: noswitch = len(args) >= 2 and args[1] == "-noswitch" full_name = buffer_closed_stack.pop() buffer_open_full_name(full_name, noswitch=noswitch) else: error("no known closed buffers") return weechat.WEECHAT_RC_ERROR elif len(args) >= 1: noswitch = args[0] == "-noswitch" if noswitch: if len(args) >= 2: full_name = args[1] else: error("missing full name") return weechat.WEECHAT_RC_ERROR else: full_name = args[0] buffer_open_full_name(full_name, noswitch=noswitch) else: error("unknown subcommand") return weechat.WEECHAT_RC_ERROR return weechat.WEECHAT_RC_OK buffer_closed_stack = [] def buffer_closing_cb(data, signal, buffer): global buffer_closed_stack full_name = weechat.buffer_get_string(buffer, "full_name") buffer_closed_stack.append(full_name) max_closed = int(weechat.config_get_plugin("max_closed")) buffer_closed_stack = buffer_closed_stack[max(0, len(buffer_closed_stack) - max_closed):] return weechat.WEECHAT_RC_OK LAYOUT_APPLY_RE = re.compile(r"^/layout apply(?:\s+(\S+)(?:\s+buffers)?)?$") def layout_apply_cb(data, buffer, command): if weechat.config_string_to_boolean(weechat.config_get_plugin("layout_apply")): m = LAYOUT_APPLY_RE.match(command) if m: layout_name = m.group(1) or "default" hdata_layout = weechat.hdata_get("layout") layouts = weechat.hdata_get_list(hdata_layout, "gui_layouts") layout = hdata_search(hdata_layout, layouts, "${layout.name}", layout_name) if layout: hdata_layout_buffer = weechat.hdata_get("layout_buffer") layout_buffer = weechat.hdata_pointer(hdata_layout, layout, "layout_buffers") while layout_buffer: plugin_name = weechat.hdata_string(hdata_layout_buffer, layout_buffer, "plugin_name") buffer_name = weechat.hdata_string(hdata_layout_buffer, layout_buffer, "buffer_name") full_name = "{}.{}".format(plugin_name, buffer_name) buffer = weechat.buffer_search("==", full_name) if not buffer: buffer_open_full_name(full_name, noswitch=True) layout_buffer = weechat.hdata_move(hdata_layout_buffer, layout_buffer, 1) return weechat.WEECHAT_RC_OK if __name__ == "__main__" and IMPORT_OK: if weechat.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION, SCRIPT_LICENSE, SCRIPT_DESC, "", ""): weechat.hook_hsignal("10000|buffer_open_full_name", "buffer_open_full_name_opened_cb", "") weechat.hook_hsignal("0|buffer_open_full_name", "buffer_open_full_name_unhandled_cb", "") weechat.hook_hsignal("500|buffer_open_full_name", "buffer_open_full_name_table_cb", "") weechat.hook_hsignal("500|buffer_open_full_name", "buffer_open_full_name_irc_cb", "") weechat.hook_signal("irc_server_connected", "irc_server_connected_cb", "") weechat.hook_command(SCRIPT_COMMAND, SCRIPT_DESC, """closed [-noswitch|-list] || [-noswitch] <full name>""", """ closed: open most recently closed buffer closed -list: list most recently closed buffers -noswitch: try not to switch to new buffer Without subcommand, this command opens a buffer with given full name. Option "{prefix}.max_closed" specifies the number of most recently closed buffers that are remembered. If option "{prefix}.layout_apply" is on and "/layout apply" is executed, closed buffers in the layout are opened.""".format(prefix="plugins.var.python.{}".format(SCRIPT_NAME)), """closed -noswitch|-list %- || -noswitch""".replace("\n", ""), "command_cb", "") weechat.hook_signal("buffer_closing", "buffer_closing_cb", "") weechat.hook_command_run("/layout apply*", "layout_apply_cb", "") for option, value in SETTINGS.items(): if not weechat.config_is_set_plugin(option): weechat.config_set_plugin(option, value[0]) weechat.config_set_desc_plugin(option, "{} (default: \"{}\")".format(value[1], value[0])) |