… | |
… | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Every time a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8' |
26 | thus must be encoded as UTF-8. |
26 | environment, and thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in urxvtd, where |
28 | Each script will only ever be loaded once, even in urxvtd, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
… | |
… | |
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
120 | different types of metadata. These comments are scanned whenever a |
120 | different types of metadata. These comments are scanned whenever a |
121 | terminal is created and are typically used to autoload extensions when |
121 | terminal is created and are typically used to autoload extensions when |
122 | their resources or command line parameters are used. |
122 | their resources or command line parameters are used. |
123 | |
123 | |
124 | Currently, it recognises only one such comment: |
124 | Currently, it recognises these comments below. Individual components are |
|
|
125 | separated by cololns (C<:>), and shoudl not contain colons themselves - |
|
|
126 | there is also currently no escaping mechanism provided for this. |
125 | |
127 | |
126 | =over |
128 | =over |
127 | |
129 | |
128 | =item #:META:RESOURCE:name:type:desc |
130 | =item #:META:RESOURCE:name:type:desc |
129 | |
131 | |
… | |
… | |
131 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
133 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
132 | or C<string>, and C<desc> is the resource description. |
134 | or C<string>, and C<desc> is the resource description. |
133 | |
135 | |
134 | The extension will be autoloaded when this resource is specified or used |
136 | The extension will be autoloaded when this resource is specified or used |
135 | as a command line parameter. |
137 | as a command line parameter. |
|
|
138 | |
|
|
139 | Example: matcher provides the C<matcher.launcher> ressource by having this |
|
|
140 | comment: |
|
|
141 | |
|
|
142 | #:META:RESOURCE:%.launcher:string:default launcher command |
|
|
143 | |
|
|
144 | Example: load this extension when the C<-tr> command line option or |
|
|
145 | resource name is used. |
|
|
146 | |
|
|
147 | #:META:RESOURCE:tr:boolean:set root pixmap as background |
|
|
148 | |
|
|
149 | =item #:META:OSC:number:desc |
|
|
150 | |
|
|
151 | The OSC comment specifies an OSC sequence, where C<number> is the |
|
|
152 | numerical OSC code and C<desc> is a short description that is currently |
|
|
153 | unused. |
|
|
154 | |
|
|
155 | This will cause the extension to be autoloaded when the OSC sequence is |
|
|
156 | used for the first time. |
|
|
157 | |
|
|
158 | Note that autoloading carries some extra responsibilities with it: |
|
|
159 | although the terminal cnanot really protect itself against malicious |
|
|
160 | sources of command sequences, therefore relying on the programs running |
|
|
161 | I<inside> to sanitize data that they output, it is very common for |
|
|
162 | programs to emit command sequences from untrusted sources. |
|
|
163 | |
|
|
164 | While this means that extensions should, as a defense-in-depth mechanism, |
|
|
165 | always consider whether OSC sequences are safe, autoloading automatically |
|
|
166 | exposes any autoloaded extension in all terminal windows, so extra care |
|
|
167 | should be taken. |
|
|
168 | |
|
|
169 | Example: the background extension registers OSC C<20> like this: |
|
|
170 | |
|
|
171 | #:META:OSC:20:change/query background image |
|
|
172 | |
|
|
173 | =item #:META:OSC_PERL:prefix:desc |
|
|
174 | |
|
|
175 | The same as the OSC comment, but for the Perl OSC sequence (C<777>). The |
|
|
176 | C<prefix> should be unique among extensions, of course, which is most |
|
|
177 | easily arranged by using the extension name, although this is not |
|
|
178 | required. |
|
|
179 | |
|
|
180 | Example: the overlay-osc extension registers its Perl OSC like this: |
|
|
181 | |
|
|
182 | #:META:OSC_PERL:overlay:man overlay-osc |
136 | |
183 | |
137 | =back |
184 | =back |
138 | |
185 | |
139 | =head2 Hooks |
186 | =head2 Hooks |
140 | |
187 | |
… | |
… | |
240 | |
287 | |
241 | C<on_osc_seq_perl> should be used for new behaviour. |
288 | C<on_osc_seq_perl> should be used for new behaviour. |
242 | |
289 | |
243 | =item on_osc_seq_perl $term, $args, $resp |
290 | =item on_osc_seq_perl $term, $args, $resp |
244 | |
291 | |
245 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
292 | Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence |
246 | operating system command) is processed. Cursor position and other state |
293 | (OSC = operating system command) is processed. Cursor position and other |
247 | information is up-to-date when this happens. For interoperability, the |
294 | state information is up-to-date when this happens. For interoperability, |
248 | string should start with the extension name (sans -osc) and a semicolon, |
295 | the argument should start with the extension name (sans -osc) or some |
249 | to distinguish it from commands for other extensions, and this might be |
296 | other suitable prefix, and a semicolon, to distinguish it from commands |
250 | enforced in the future. |
297 | for other extensions. |
251 | |
298 | |
252 | For example, C<overlay-osc> uses this: |
299 | For example, C<overlay-osc> uses this: |
253 | |
300 | |
254 | sub on_osc_seq_perl { |
301 | sub on_osc_seq_perl { |
255 | my ($self, $osc, $resp) = @_; |
302 | my ($self, $osc, $resp) = @_; |
… | |
… | |
400 | =cut |
447 | =cut |
401 | |
448 | |
402 | package urxvt; |
449 | package urxvt; |
403 | |
450 | |
404 | use utf8; |
451 | use utf8; |
405 | use strict 'vars'; |
452 | use strict qw(vars subs); |
406 | use Carp (); |
453 | use Carp (); |
407 | use Scalar::Util (); |
454 | use Scalar::Util (); |
408 | use List::Util (); |
455 | use List::Util (); |
409 | |
456 | |
410 | our $VERSION = 1; |
457 | our $VERSION = 1; |
… | |
… | |
666 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
713 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
667 | } |
714 | } |
668 | } |
715 | } |
669 | } |
716 | } |
670 | |
717 | |
671 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
718 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2; |
672 | |
719 | |
673 | sub verbose { |
720 | sub verbose { |
674 | my ($level, $msg) = @_; |
721 | my ($level, $msg) = @_; |
675 | warn "$msg\n" if $level <= $verbosity; |
722 | warn "$msg\n" if $level <= $verbosity; |
676 | } |
723 | } |
… | |
… | |
693 | |
740 | |
694 | open my $fh, "<:raw", $path |
741 | open my $fh, "<:raw", $path |
695 | or die "$path: $!"; |
742 | or die "$path: $!"; |
696 | |
743 | |
697 | my $source = |
744 | my $source = |
698 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
745 | "package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n" |
699 | . "#line 1 \"$path\"\n{\n" |
746 | . "#line 1 \"$path\"\n{\n" |
700 | . (do { local $/; <$fh> }) |
747 | . (do { local $/; <$fh> }) |
701 | . "\n};\n1"; |
748 | . "\n};\n1"; |
702 | |
749 | |
703 | eval $source |
750 | eval $source |
… | |
… | |
713 | sub invoke { |
760 | sub invoke { |
714 | local $TERM = shift; |
761 | local $TERM = shift; |
715 | my $htype = shift; |
762 | my $htype = shift; |
716 | |
763 | |
717 | if ($htype == HOOK_INIT) { |
764 | if ($htype == HOOK_INIT) { |
718 | my @dirs = $TERM->perl_libdirs; |
|
|
719 | |
|
|
720 | $TERM->scan_extensions; |
765 | $TERM->scan_extensions; |
721 | |
766 | |
722 | my %ext_arg; |
767 | my %ext_arg; |
723 | |
768 | |
724 | { |
769 | { |
… | |
… | |
746 | my $ext = $1; |
791 | my $ext = $1; |
747 | |
792 | |
748 | $ext_arg{$ext} = []; |
793 | $ext_arg{$ext} = []; |
749 | } |
794 | } |
750 | |
795 | |
751 | } elsif (/^-(.*)$/) { |
796 | } elsif (/^-(.*)$/) { # remove from set |
752 | delete $ext_arg{$1}; |
797 | delete $ext_arg{$1}; |
753 | |
798 | |
754 | } elsif (/^([^<]+)<(.*)>$/) { |
799 | } elsif (/^\/(.*)$/) { # prohibit loading |
|
|
800 | undef $TERM->{ext_prohibit}{$1}; |
|
|
801 | |
|
|
802 | } elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status |
|
|
803 | delete $TERM->{ext_prohibit}{$1}; |
755 | push @{ $ext_arg{$1} }, $2; |
804 | push @{ $ext_arg{$1} }, defined $2 ? $2 : (); |
756 | |
805 | |
757 | } else { |
806 | } else { |
758 | $ext_arg{$_} ||= []; |
807 | verbose 2, "cannot parse extension specification '$_', ignoring."; |
759 | } |
808 | } |
760 | } |
809 | } |
761 | |
810 | |
|
|
811 | $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc}; |
|
|
812 | $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl}; |
|
|
813 | |
762 | for my $ext (sort keys %ext_arg) { |
814 | for my $ext (sort keys %ext_arg) { |
763 | my @files = grep -f $_, map "$_/$ext", @dirs; |
815 | my $path = $TERM->extension_path ($ext); |
764 | |
816 | |
765 | if (@files) { |
817 | if (defined $path) { |
766 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
818 | $TERM->autoload_extension ($ext, $ext_arg{$ext}); |
767 | } else { |
819 | } else { |
768 | warn "perl extension '$ext' not found in perl library search path\n"; |
820 | verbose 2, "perl extension '$ext' not found in perl library search path"; |
769 | } |
821 | } |
770 | } |
822 | } |
771 | |
823 | |
772 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
824 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
773 | warn $@ if $@; |
825 | warn $@ if $@; |
774 | } |
826 | } |
775 | |
827 | |
776 | $retval = undef; |
828 | $retval = undef; |
|
|
829 | |
|
|
830 | if ($htype == HOOK_OSC_SEQ) { |
|
|
831 | if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) { |
|
|
832 | $TERM->autoload_extension ($_->[0]) for @$exts; |
|
|
833 | } |
|
|
834 | } elsif ($htype == HOOK_OSC_SEQ_PERL) { |
|
|
835 | if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) { |
|
|
836 | $TERM->autoload_extension ($_->[0]) for @$exts; |
|
|
837 | } |
|
|
838 | } |
777 | |
839 | |
778 | if (my $cb = $TERM->{_hook}[$htype]) { |
840 | if (my $cb = $TERM->{_hook}[$htype]) { |
779 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
841 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
780 | if $verbosity >= 10; |
842 | if $verbosity >= 10; |
781 | |
843 | |
… | |
… | |
1140 | $proxy->enable ($name => $ref); |
1202 | $proxy->enable ($name => $ref); |
1141 | } |
1203 | } |
1142 | } |
1204 | } |
1143 | } |
1205 | } |
1144 | |
1206 | |
|
|
1207 | # map extension name to filesyystem path |
|
|
1208 | sub extension_path { |
|
|
1209 | (grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0] |
|
|
1210 | } |
|
|
1211 | |
|
|
1212 | # load an extension by name |
|
|
1213 | sub load_extension_file { |
|
|
1214 | my ($self, $path, $argv) = @_; |
|
|
1215 | |
|
|
1216 | $self->register_package (urxvt::extension_package $path, $argv); |
|
|
1217 | } |
|
|
1218 | |
|
|
1219 | # autoload an extension unless loading it is prohibited |
|
|
1220 | sub autoload_extension { |
|
|
1221 | my ($self, $name, $argv) = @_; |
|
|
1222 | |
|
|
1223 | return if exists $self->{ext_prohibit}{$name}; |
|
|
1224 | |
|
|
1225 | my $path = $self->extension_path ($name) |
|
|
1226 | // return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)"; |
|
|
1227 | |
|
|
1228 | $self->load_extension_file ($path, $argv); |
|
|
1229 | } |
|
|
1230 | |
1145 | sub perl_libdirs { |
1231 | sub perl_libdirs { |
1146 | map { split /:/ } |
1232 | map { split /:/ } |
1147 | $_[0]->resource ("perl_lib"), |
1233 | $_[0]->resource ("perl_lib"), |
1148 | $ENV{URXVT_PERL_LIB}, |
1234 | $ENV{URXVT_PERL_LIB}, |
1149 | "$ENV{HOME}/.urxvt/ext", |
1235 | "$ENV{HOME}/.urxvt/ext", |
… | |
… | |
1157 | return if exists $self->{meta}; |
1243 | return if exists $self->{meta}; |
1158 | |
1244 | |
1159 | my @urxvtdirs = perl_libdirs $self; |
1245 | my @urxvtdirs = perl_libdirs $self; |
1160 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1246 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1161 | |
1247 | |
1162 | $self->{meta} = \my %meta; |
1248 | $self->{meta} = \my %allmeta; |
1163 | |
1249 | |
1164 | # first gather extensions |
1250 | # first gather extensions |
1165 | |
1251 | |
1166 | my $gather = sub { |
1252 | my $gather = sub { |
1167 | my ($dir, $core) = @_; |
1253 | my ($dir, $core) = @_; |
… | |
… | |
1180 | or next; |
1266 | or next; |
1181 | |
1267 | |
1182 | $ext =~ s/\.uext$// or $core |
1268 | $ext =~ s/\.uext$// or $core |
1183 | or next; |
1269 | or next; |
1184 | |
1270 | |
1185 | my %ext = (dir => $dir); |
1271 | my %meta = (dir => $dir); |
1186 | |
1272 | |
1187 | while (<$fh>) { |
1273 | while (<$fh>) { |
1188 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1274 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1189 | my ($pattern, $type, $desc) = split /:/, $1; |
1275 | my ($pattern, $type, $desc) = split /:/, $1; |
1190 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1276 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1191 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1277 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1192 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1278 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1193 | } else { |
1279 | } else { |
1194 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1280 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1195 | } |
1281 | } |
|
|
1282 | |
|
|
1283 | } elsif (/^#:META:OSC:([0-9]+):(.*)/) { |
|
|
1284 | push @{$allmeta{autoload_osc}{$1}}, [$ext, $2]; |
|
|
1285 | |
|
|
1286 | } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) { |
|
|
1287 | push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2]; |
|
|
1288 | |
1196 | } elsif (/^\s*(?:#|$)/) { |
1289 | } elsif (/^\s*(?:#|$)/) { |
1197 | # skip other comments and empty lines |
1290 | # skip other comments and empty lines |
|
|
1291 | |
1198 | } else { |
1292 | } else { |
1199 | last; # stop parsing on first non-empty non-comment line |
1293 | last; # stop parsing on first non-empty non-comment line |
1200 | } |
1294 | } |
1201 | } |
1295 | } |
1202 | |
1296 | |
1203 | $meta{ext}{$ext} = \%ext; |
1297 | $allmeta{ext}{$ext} = \%meta; |
1204 | } |
1298 | } |
1205 | }; |
1299 | }; |
1206 | |
1300 | |
1207 | # $gather->($_, 0) for @cpandirs; |
1301 | # $gather->($_, 0) for @cpandirs; |
1208 | $gather->($_, 1) for @urxvtdirs; |
1302 | $gather->($_, 1) for @urxvtdirs; |
1209 | |
1303 | |
1210 | # and now merge resources |
1304 | # and now merge resources |
1211 | |
1305 | |
1212 | $meta{resource} = \my %resource; |
1306 | $allmeta{resource} = \my %resource; |
1213 | |
1307 | |
1214 | while (my ($k, $v) = each %{ $meta{ext} }) { |
1308 | while (my ($k, $v) = each %{ $allmeta{ext} }) { |
1215 | #TODO: should check for extensions overriding each other |
1309 | #TODO: should check for extensions overriding each other |
1216 | %resource = (%resource, %{ $v->{resource} }); |
1310 | %resource = (%resource, %{ $v->{resource} }); |
1217 | } |
1311 | } |
1218 | } |
1312 | } |
1219 | |
1313 | |
… | |
… | |
2289 | This variable controls the verbosity level of the perl extension. Higher |
2383 | This variable controls the verbosity level of the perl extension. Higher |
2290 | numbers indicate more verbose output. |
2384 | numbers indicate more verbose output. |
2291 | |
2385 | |
2292 | =over |
2386 | =over |
2293 | |
2387 | |
2294 | =item == 0 - fatal messages |
2388 | =item == 0 - fatal messages only |
|
|
2389 | |
|
|
2390 | =item >= 2 - general warnings (default level) |
2295 | |
2391 | |
2296 | =item >= 3 - script loading and management |
2392 | =item >= 3 - script loading and management |
2297 | |
2393 | |
2298 | =item >=10 - all called hooks |
2394 | =item >=10 - all called hooks |
2299 | |
2395 | |