├── .gitignore ├── README.md ├── INSTALL.md ├── schema.pl ├── fbmenugen └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /blib/ 2 | /.build/ 3 | _build/ 4 | cover_db/ 5 | inc/ 6 | Build 7 | !Build/ 8 | Build.bat 9 | .last_cover_stats 10 | /Makefile 11 | /Makefile.old 12 | /MANIFEST.bak 13 | /META.yml 14 | /META.json 15 | /MYMETA.* 16 | nytprof.out 17 | /pm_to_blib 18 | *.o 19 | *.bs 20 | /_eumm/ 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | fbmenugen 2 | ================ 3 | 4 | Fluxbox menu generator (with support for icons) 5 | 6 | ![fbmenugen](https://3.bp.blogspot.com/-bXRWyjzBJ2Y/WfE0MkJ4aqI/AAAAAAAAnPs/RlgQ1NzEABsMaGu4_NuVFGRE7LX6Cc3fwCLcBGAs/s1600/fbmenugen.png) 7 | 8 | ---- 9 | 10 | ``` 11 | usage: fbmenugen [options] 12 | 13 | menu: 14 | -g : generate a new menu 15 | -i : include icons 16 | -p : pipe menu (prints to STDOUT) 17 | 18 | misc: 19 | -u : update the config file 20 | -d : regenerate the cache file 21 | -S : absolute path to the schema.pl file 22 | -C : absolute path to the config.pl file 23 | -o : menu file (default: ~/.fluxbox/menu) 24 | 25 | info: 26 | -h : print this message and exit 27 | -v : print version and exit 28 | 29 | example: 30 | fbmenugen -g -i # generates a menu with icons 31 | 32 | => Config file: ~/.config/fbmenugen/config.pl 33 | => Schema file: ~/.config/fbmenugen/schema.pl 34 | ``` 35 | 36 | ---- 37 | 38 | Installation: [INSTALL.md](INSTALL.md) 39 | -------------------------------------------------------------------------------- /INSTALL.md: -------------------------------------------------------------------------------- 1 | ## Installation of fbmenugen 2 | 3 | * Required dependencies: 4 | 5 | - perl>=5.14.0 6 | - perl-gtk3 ([Gtk3](https://metacpan.org/pod/Gtk3)) (for icons) 7 | - perl-data-dump ([Data::Dump](https://metacpan.org/pod/Data::Dump)) 8 | - perl-linux-desktopfiles>=0.25 ([Linux::DesktopFiles](https://metacpan.org/pod/Linux::DesktopFiles)) 9 | 10 | * Optional dependencies: 11 | - perl-file-desktopentry ([File::DesktopEntry](https://metacpan.org/pod/File::DesktopEntry)) 12 | 13 | ### Installation process: 14 | 15 | - place the `fbmenugen` file inside your PATH 16 | - place the `schema.pl` file inside `~/.config/fbmenugen/` 17 | 18 | ### Running: 19 | 20 | - to generate a menu with icons, execute: `fbmenugen -i` 21 | - to generate a menu without icons, execute: `fbmenugen` 22 | 23 | ### Locale support: 24 | 25 | - If [File::DesktopEntry](https://metacpan.org/pod/File::DesktopEntry) is installed, `fbmenugen` will use it to provide locale support. 26 | 27 | ### Customizing: 28 | 29 | - the `schema.pl` file provides a direct customization access to the menu that will be generated. 30 | - adding or removing a given entry from the `schema.pl` file, is reflected inside the generated menu. 31 | 32 | ### Availability: 33 | 34 | - [Arch Linux](https://aur.archlinux.org/packages/fbmenugen/) 35 | -------------------------------------------------------------------------------- /schema.pl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | # fbmenugen - schema file 4 | 5 | =for comment 6 | 7 | item: add an item inside the menu {item => ["command", "label", "icon"]}, 8 | cat: add a category inside the menu {cat => ["name", "label", "icon"]}, 9 | sep: horizontal line separator {sep => undef}, {sep => "label"}, 10 | raw: any valid Fluxbox menu entry {raw => q(...)}, 11 | beg: begin of a category {beg => ["name", "icon"]}, 12 | end: end of a category {end => undef}, 13 | fluxbox: the default Fluxbox config menu {fluxbox => ["label", "icon"]}, 14 | exit: default "Exit" action {exit => ["label", "icon"]}, 15 | 16 | =cut 17 | 18 | # NOTE: 19 | # * Keys and values are case sensitive. Keep all keys lowercase. 20 | # * ICON can be a either a direct path to an icon or a valid icon name 21 | # * Category names are case insensitive. (X-XFCE and x_xfce are equivalent) 22 | 23 | require "$ENV{HOME}/.config/fbmenugen/config.pl"; 24 | 25 | ## Text editor 26 | my $editor = $CONFIG->{editor}; 27 | 28 | our $SCHEMA = [ 29 | 30 | # COMMAND LABEL ICON 31 | {item => ['xdg-open .', 'File Manager', 'system-file-manager']}, 32 | {item => ['xterm', 'Terminal', 'utilities-terminal']}, 33 | {item => ['xdg-open http://', 'Web Browser', 'web-browser']}, 34 | {item => ['fbrun', 'Run command', 'system-run']}, 35 | 36 | {sep => 'undef'}, 37 | 38 | # NAME LABEL ICON 39 | {cat => ['utility', 'Accessories', 'applications-utilities']}, 40 | {cat => ['development', 'Development', 'applications-development']}, 41 | {cat => ['education', 'Education', 'applications-science']}, 42 | {cat => ['game', 'Games', 'applications-games']}, 43 | {cat => ['graphics', 'Graphics', 'applications-graphics']}, 44 | {cat => ['audiovideo', 'Multimedia', 'applications-multimedia']}, 45 | {cat => ['network', 'Network', 'applications-internet']}, 46 | {cat => ['office', 'Office', 'applications-office']}, 47 | {cat => ['other', 'Other', 'applications-other']}, 48 | {cat => ['settings', 'Settings', 'applications-accessories']}, 49 | {cat => ['system', 'System', 'applications-system']}, 50 | 51 | # LABEL ICON 52 | #{beg => ['My category', 'cat-icon']}, 53 | # ... some items ... 54 | #{end => undef}, 55 | 56 | ## Custom advanced settings 57 | {sep => undef}, 58 | {beg => ['Advanced Settings', 'applications-engineering']}, 59 | 60 | # Configuration files 61 | {item => ["$editor ~/.conkyrc", 'Conky RC', 'text-x-generic']}, 62 | {item => ["$editor ~/.config/tint2/tint2rc", 'Tint2 Panel', 'text-x-generic']}, 63 | 64 | # fbmenugen category 65 | {beg => ['Fbmenugen', 'accessories-text-editor']}, 66 | 67 | {item => ["$editor ~/.config/fbmenugen/schema.pl", 'Menu Schema', 'text-x-generic']}, 68 | {item => ["$editor ~/.config/fbmenugen/config.pl", 'Menu Config', 'text-x-generic']}, 69 | 70 | {sep => undef}, 71 | {item => ['fbmenugen -i', 'Generate a menu with icons', 'accessories-text-editor']}, 72 | {item => ['fbmenugen -g', 'Generate a menu without icons', 'accessories-text-editor']}, 73 | {sep => undef}, 74 | 75 | {item => ['fbmenugen -d', 'Refresh cache', 'view-refresh']}, 76 | {end => undef}, 77 | 78 | # Fluxbox category 79 | {fluxbox => ['Fluxbox', 'preferences-desktop']}, 80 | {end => undef}, 81 | 82 | {sep => undef}, 83 | 84 | # Regenerate the menu 85 | {regenerate => ['Refresh', 'view-refresh']}, 86 | 87 | # This option uses the default Fluxbox's "Exit" action 88 | {exit => ['Exit', 'application-exit']}, 89 | ] 90 | -------------------------------------------------------------------------------- /fbmenugen: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | 3 | # Copyright (C) 2010-2023 Daniel "Trizen" Șuteu . 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | 18 | # Fluxbox Menu Generator 19 | # A simple menu generator for the Fluxbox Window Manager 20 | # Should be installed in $PATH before the first execution! 21 | 22 | # Name: fbmenugen 23 | # License: GPLv3 24 | # Created on: 01 August 2010 25 | # Latest edit on: 22 September 2023 26 | # https://github.com/trizen/fbmenugen 27 | 28 | use 5.014; 29 | use File::Spec; 30 | use Linux::DesktopFiles 0.25; 31 | 32 | my $pkgname = 'fbmenugen'; 33 | my $version = '0.88'; 34 | 35 | my ($with_icons, $db_clean, $create_menu, $pipe, $reload_config, $update_config); 36 | 37 | our ($CONFIG, $SCHEMA); 38 | 39 | my $home_dir = 40 | $ENV{HOME} 41 | || $ENV{LOGDIR} 42 | || (getpwuid($<))[7] 43 | || `echo -n ~`; 44 | 45 | my $xdg_config_home = $ENV{XDG_CONFIG_HOME} || "$home_dir/.config"; 46 | my $xdg_cache_home = $ENV{XDG_CACHE_HOME} || "$home_dir/.cache"; 47 | 48 | my $config_dir = "$xdg_config_home/$pkgname"; 49 | my $schema_file = "$config_dir/schema.pl"; 50 | my $config_file = "$config_dir/config.pl"; 51 | my $cache_dir = "$xdg_cache_home/$pkgname"; 52 | my $fluxbox_dir = "$home_dir/.fluxbox"; 53 | my $menu_file = "$fluxbox_dir/menu"; 54 | my $cache_db = "$cache_dir/cache.db"; 55 | my $icons_dir = "$cache_dir/icons"; 56 | 57 | sub usage { 58 | print <<"HELP"; 59 | usage: $0 [options] 60 | 61 | menu: 62 | -g : generate a new menu 63 | -i : include icons 64 | -p : pipe menu (prints to STDOUT) 65 | 66 | misc: 67 | -u : update the config file 68 | -d : regenerate the cache file 69 | -S : absolute path to the schema.pl file 70 | -C : absolute path to the config.pl file 71 | -o : menu file (default: ~/.fluxbox/menu) 72 | 73 | info: 74 | -h : print this message and exit 75 | -v : print version and exit 76 | 77 | example: 78 | $0 -g -i # generates a menu with icons 79 | 80 | => Config file: $config_file 81 | => Schema file: $schema_file 82 | HELP 83 | exit 0; 84 | } 85 | 86 | my $config_help = <<"HELP"; 87 | 88 | || FILTERING 89 | | skip_filename_re : Skip a .desktop file if its name matches the regex. 90 | Name is from the last slash to the end. (e.g.: name.desktop) 91 | Example: qr/^(?:gimp|xterm)\\b/, # skips 'gimp' and 'xterm' 92 | 93 | | skip_entry : Skip a desktop file if the value from a given key matches the regex. 94 | Example: [ 95 | {key => 'Name', re => qr/(?:about|terminal)/i}, 96 | {key => 'Exec', re => qr/^xterm/}, 97 | {key => 'OnlyShowIn', re => qr/XFCE/}, 98 | ], 99 | 100 | | substitutions : Substitute, by using a regex, in the values from the desktop files. 101 | Example: [ 102 | {key => 'Exec', re => qr/xterm/, value => 'tilix', global => 1}, 103 | ], 104 | 105 | || ICON SETTINGS 106 | | gtk_version : The version of the Gtk library used for resolving the icon paths. (default: 3) 107 | | gtk_rc_filename : Absolute path to the Gtk configuration file. 108 | | missing_icon : Use this icon for missing icons (default: gtk-missing-image) 109 | | icon_size : Preferred size for icons. (default: 32) 110 | | generic_fallback : Try to shorten icon name at '-' characters before looking at inherited themes. (default: 0) 111 | | force_icon_size : Always get the icon scaled to the requested size. (default: 0) 112 | 113 | || PATHS 114 | | desktop_files_paths : Absolute paths which contain .desktop files. 115 | Example: [ 116 | '/usr/share/applications', 117 | "\$ENV{HOME}/.local/share/applications", 118 | glob("\$ENV{HOME}/.local/share/applications/wine/Programs/*"), 119 | ], 120 | 121 | || NOTES 122 | | Regular expressions: 123 | * use qr/.../ instead of '...' 124 | * use qr/.../i for case insensitive mode 125 | HELP 126 | 127 | sub remove_database { 128 | my ($db) = @_; 129 | 130 | foreach my $file ($db, "$db.dir", "$db.pag") { 131 | unlink($file) if (-e $file); 132 | } 133 | } 134 | 135 | if (@ARGV) { 136 | while (defined(my $arg = shift @ARGV)) { 137 | if ($arg eq '-i') { 138 | $with_icons = 1; 139 | $create_menu = 1; 140 | } 141 | elsif ($arg eq '-g') { 142 | $create_menu = 1; 143 | } 144 | elsif ($arg eq '-p') { 145 | $pipe = 1; 146 | } 147 | elsif ($arg eq '-d') { 148 | $db_clean = 1; 149 | print STDERR ":: Regenerating the cache DB...\n"; 150 | remove_database($cache_db); 151 | } 152 | elsif ($arg eq '-u') { 153 | $update_config = 1; 154 | } 155 | elsif ($arg eq '-v') { 156 | print "$pkgname $version\n"; 157 | exit 0; 158 | } 159 | elsif ($arg eq '-o') { 160 | $menu_file = shift(@ARGV) // die "$0: option '-o' requires an argument!\n"; 161 | } 162 | elsif ($arg eq '-S') { 163 | $schema_file = shift(@ARGV) // die "$0: option '-S' requires an argument!\n"; 164 | } 165 | elsif ($arg eq '-C') { 166 | $reload_config = 1; 167 | $config_file = shift(@ARGV) // die "$0: options '-C' requires an argument!\n"; 168 | } 169 | elsif ($arg eq '-h') { 170 | usage(); 171 | } 172 | else { 173 | die "$0: option `$arg' is invalid!\n"; 174 | } 175 | } 176 | } 177 | 178 | if (not -d $config_dir) { 179 | require File::Path; 180 | File::Path::make_path($config_dir) 181 | or die "$0: can't create configuration directory `$config_dir': $!\n"; 182 | } 183 | 184 | if (not -d $cache_dir) { 185 | require File::Path; 186 | File::Path::make_path($cache_dir) 187 | or die "$0: can't create cache directory `$cache_dir': $!\n"; 188 | } 189 | 190 | if ($with_icons and not -d $icons_dir) { 191 | remove_database($cache_db); 192 | require File::Path; 193 | File::Path::make_path($icons_dir) 194 | or warn "$0: can't create icon path `$icons_dir': $!\n"; 195 | } 196 | 197 | my $config_documentation = <<"EOD"; 198 | #!/usr/bin/perl 199 | 200 | # $pkgname - configuration file 201 | # This file will be updated automatically. 202 | # Any additional comment and/or indentation will be lost. 203 | 204 | =for comment 205 | $config_help 206 | =cut 207 | 208 | EOD 209 | 210 | my %CONFIG = ( 211 | 'Linux::DesktopFiles' => { 212 | 213 | keep_unknown_categories => 1, 214 | unknown_category_key => 'other', 215 | 216 | skip_entry => undef, 217 | substitutions => undef, 218 | skip_filename_re => undef, 219 | 220 | terminalize => 1, 221 | terminalization_format => q{%s -e '%s'}, 222 | 223 | #<<< 224 | desktop_files_paths => [ 225 | '/usr/share/applications', 226 | '/usr/local/share/applications', 227 | '/usr/share/applications/kde4', 228 | "$home_dir/.local/share/applications", 229 | ], 230 | #>>> 231 | }, 232 | 233 | menu_title => 'Fluxbox', 234 | terminal => 'xterm', 235 | editor => 'geany', 236 | missing_icon => 'gtk-missing-image', 237 | gtk_rc_filename => "$home_dir/.config/gtk-3.0/settings.ini", 238 | 239 | icon_size => 32, 240 | force_icon_size => 0, 241 | generic_fallback => 0, 242 | locale_support => 1, 243 | gtk_version => 3, 244 | 245 | VERSION => $version, 246 | ); 247 | 248 | sub dump_configuration { 249 | require Data::Dump; 250 | open my $config_fh, '>', $config_file 251 | or die "Can't open file '${config_file}' for write: $!"; 252 | my $dumped_config = q{our $CONFIG = } . Data::Dump::dump(\%CONFIG) . "\n"; 253 | $dumped_config =~ s/\Q$home_dir\E/\$ENV{HOME}/g if ($home_dir eq $ENV{HOME}); 254 | print $config_fh $config_documentation, $dumped_config; 255 | close $config_fh; 256 | } 257 | 258 | if (not -e $config_file) { 259 | dump_configuration(); 260 | } 261 | 262 | if (not -e $schema_file) { 263 | if (-e (my $etc_schema_file = "/etc/xdg/$pkgname/schema.pl")) { 264 | require File::Copy; 265 | File::Copy::copy($etc_schema_file, $schema_file) 266 | or warn "$0: can't copy file `$etc_schema_file' to `$schema_file': $!\n"; 267 | } 268 | else { 269 | die "$0: schema file `$schema_file' does not exists!\n"; 270 | } 271 | } 272 | 273 | foreach my $file (\$schema_file, \$config_file) { 274 | if (not File::Spec->file_name_is_absolute($$file)) { 275 | $$file = File::Spec->rel2abs($$file); 276 | } 277 | } 278 | 279 | # Load the configuration files 280 | require $schema_file; 281 | require $config_file if $reload_config; 282 | 283 | # Remove invalid user-defined keys 284 | my @valid_keys = grep { exists $CONFIG{$_} } keys %$CONFIG; 285 | @CONFIG{@valid_keys} = @{$CONFIG}{@valid_keys}; 286 | 287 | if ($CONFIG{VERSION} != $version) { 288 | $CONFIG{VERSION} = $version; 289 | dump_configuration(); 290 | } 291 | 292 | #<<< 293 | my @desktop_files_paths = do { 294 | my %seen; 295 | grep { !$seen{$_}++ } ( 296 | ($ENV{XDG_DATA_DIRS} ? split(/:/, $ENV{XDG_DATA_DIRS}) : ()), 297 | @{$CONFIG{'Linux::DesktopFiles'}{desktop_files_paths}}, 298 | ); 299 | }; 300 | #>>> 301 | 302 | my $desk_obj = Linux::DesktopFiles->new( 303 | %{$CONFIG{'Linux::DesktopFiles'}}, 304 | desktop_files_paths => \@desktop_files_paths, 305 | 306 | categories => [map { exists($_->{cat}) ? $_->{cat}[0] : () } @$SCHEMA], 307 | 308 | keys_to_keep => ['Name', 'Exec', 'Path', 309 | ($with_icons ? 'Icon' : ()), 310 | ( 311 | ref($CONFIG{'Linux::DesktopFiles'}{skip_entry}) eq 'ARRAY' 312 | ? (map { $_->{key} } @{$CONFIG{'Linux::DesktopFiles'}{skip_entry}}) 313 | : () 314 | ), 315 | ], 316 | 317 | terminal => $CONFIG{terminal}, 318 | case_insensitive_cats => 1, 319 | ); 320 | 321 | my $generated_menu = <<"HEADER"; 322 | # 323 | ## Menu generated with $pkgname v$version 324 | # 325 | 326 | [begin] ($CONFIG{menu_title}) 327 | [encoding] {UTF-8} 328 | HEADER 329 | 330 | { 331 | my $menu_backup = $menu_file . '.bak'; 332 | if (not -e $menu_backup and -e $menu_file) { 333 | require File::Copy; 334 | File::Copy::cp($menu_file, $menu_backup); 335 | } 336 | } 337 | 338 | sub get_icon_path { 339 | my ($name) = @_; 340 | 341 | state $gtk = do { 342 | 343 | require Digest::MD5; 344 | 345 | ($CONFIG{gtk_version} == 3) 346 | ? do { 347 | eval "use Gtk3"; 348 | 'Gtk3'->init; 349 | 'Gtk3'; 350 | } 351 | : do { 352 | require Gtk2; 353 | 'Gtk2'->init; 354 | 'Gtk2'; 355 | }; 356 | }; 357 | 358 | state $theme = 359 | ($gtk eq 'Gtk2') 360 | ? Gtk2::IconTheme->get_default 361 | : Gtk3::IconTheme::get_default(); 362 | 363 | #<<< 364 | state $flags = "${gtk}::IconLookupFlags"->new( 365 | [ 366 | ($CONFIG{force_icon_size} ? 'force-size' : ()), 367 | ($CONFIG{generic_fallback} ? 'generic-fallback' : ()), 368 | ] 369 | ); 370 | #>>> 371 | 372 | foreach my $icon_name ($name, $CONFIG{missing_icon}) { 373 | 374 | #<<< 375 | my $pixbuf = eval { 376 | (substr($icon_name, 0, 1) eq '/') 377 | ? (substr($icon_name, -4) eq '.xpm') 378 | ? "${gtk}::Gdk::Pixbuf"->new_from_file($icon_name)->scale_simple($CONFIG{icon_size}, $CONFIG{icon_size}, 'hyper') 379 | : "${gtk}::Gdk::Pixbuf"->new_from_file_at_size($icon_name, $CONFIG{icon_size}, $CONFIG{icon_size}) 380 | : $theme->load_icon($icon_name, $CONFIG{icon_size}, $flags); 381 | }; 382 | #>>> 383 | 384 | if (defined($pixbuf)) { 385 | my $md5 = Digest::MD5::md5_hex($pixbuf->get_pixels); 386 | my $path = "$icons_dir/$md5.png"; 387 | $pixbuf->save($path, 'png') if not -e $path; 388 | return $path; 389 | } 390 | } 391 | 392 | return ''; 393 | } 394 | 395 | # Regenerate the cache db if the config or schema file has been modified 396 | if (!$db_clean and ((-M $config_file) < (-M $cache_db) or (-M _) > (-M $schema_file))) { 397 | print STDERR ":: Regenerating the cache DB...\n"; 398 | remove_database($cache_db); 399 | $db_clean = 1; 400 | } 401 | 402 | eval { require GDBM_File } // eval { require DB_File }; 403 | 404 | dbmopen(my %cache_db, $cache_db, 0777) 405 | or die "Can't create/access database <<$cache_db>>: $!"; 406 | 407 | # Regenerate the icon db if the GTKRC file has been modified 408 | if ($with_icons) { 409 | my $gtkrc_mtime = (stat $CONFIG{gtk_rc_filename})[9]; 410 | 411 | if ($db_clean) { 412 | $cache_db{__GTKRC_MTIME__} = $gtkrc_mtime; 413 | } 414 | else { 415 | my $old_mtime = exists($cache_db{__GTKRC_MTIME__}) ? $cache_db{__GTKRC_MTIME__} : -1; 416 | if ($old_mtime != $gtkrc_mtime) { 417 | print STDERR ":: Regenerating the cache DB...\n"; 418 | 419 | dbmclose(%cache_db); 420 | remove_database($cache_db); 421 | 422 | dbmopen(%cache_db, $cache_db, 0777) 423 | or die "Can't create database <<$cache_db>>: $!"; 424 | 425 | $cache_db{__GTKRC_MTIME__} = $gtkrc_mtime; 426 | } 427 | } 428 | } 429 | 430 | { 431 | my %fast_cache; 432 | 433 | sub check_icon { 434 | $fast_cache{$_[0] // return undef} //= do { 435 | exists($cache_db{$_[0]}) 436 | ? $cache_db{$_[0]} 437 | : do { $cache_db{$_[0]} = get_icon_path($_[0]) } 438 | }; 439 | } 440 | } 441 | 442 | sub prepare_item { 443 | my $command = shift() =~ s/\}/\\}/gr; 444 | my $name = shift() =~ s/\)/\\)/gr; 445 | my $icon = shift() || $CONFIG{missing_icon}; 446 | 447 | if ($with_icons and (my $icon_path = check_icon($icon))) { 448 | return <<"ITEM_WITH_ICON"; 449 | [exec] ($name) {$command} <$icon_path> 450 | ITEM_WITH_ICON 451 | } 452 | 453 | <<"ITEM"; 454 | [exec] ($name) {$command} 455 | ITEM 456 | } 457 | 458 | sub begin_category { 459 | my ($name, $icon) = @_; 460 | 461 | if ($with_icons and (my $icon_path = check_icon($icon))) { 462 | return <<"MENU_WITH_ICON"; 463 | [submenu] ($name) <$icon_path> 464 | MENU_WITH_ICON 465 | } 466 | 467 | <<"MENU"; 468 | [submenu] ($name) 469 | MENU 470 | } 471 | 472 | my %categories; 473 | foreach my $file ($desk_obj->get_desktop_files) { 474 | 475 | my %info = split("\0\1\0", (exists($cache_db{$file}) ? $cache_db{$file} : ''), -1); 476 | 477 | next if exists $info{__IGNORE__}; 478 | 479 | my $mtime = (stat $file)[9]; 480 | my $cache_ok = (%info and $info{__MTIME__} == $mtime); 481 | 482 | if ($with_icons and $cache_ok and not exists $info{Icon}) { 483 | $cache_ok = 0; 484 | } 485 | 486 | if (not $cache_ok) { 487 | 488 | my $entry = $desk_obj->parse_desktop_file($file) // do { 489 | $cache_db{$file} = join("\0\1\0", __IGNORE__ => 1); 490 | next; 491 | }; 492 | 493 | #<<< 494 | %info = ( 495 | Name => $entry->{Name} // next, 496 | Exec => $entry->{Exec} // next, 497 | Path => $entry->{Path} // '', 498 | 499 | ( 500 | $with_icons 501 | ? (Icon => $entry->{Icon}) 502 | : () 503 | ), 504 | 505 | __CATEGORIES__ => join(';', @{$entry->{Categories}}), 506 | __MTIME__ => $mtime, 507 | ); 508 | #>>> 509 | 510 | # Support for the Path key 511 | if ($info{Path} ne '') { 512 | require Encode; 513 | my $path = Encode::decode_utf8($info{Path}); 514 | my $exec = Encode::decode_utf8($info{Exec}); 515 | $exec = "$^X -e 'chdir(\$ARGV[0]) && exec(\$ARGV[1])' \Q$path\E \Q$exec\E"; 516 | $info{Exec} = Encode::encode_utf8($exec); 517 | } 518 | 519 | eval { 520 | 521 | state $x = do { 522 | require Encode; 523 | require File::DesktopEntry; 524 | }; 525 | 526 | $info{Name} = Encode::encode_utf8(File::DesktopEntry->new($file)->get('Name') // ''); 527 | 528 | } if $CONFIG{locale_support}; 529 | 530 | $cache_db{$file} = join("\0\1\0", %info); 531 | } 532 | 533 | foreach my $category (split(/;/, $info{__CATEGORIES__})) { 534 | push @{$categories{$category}}, \%info; 535 | } 536 | } 537 | 538 | foreach my $schema (@$SCHEMA) { 539 | if (exists $schema->{cat}) { 540 | exists($categories{my $category = lc($schema->{cat}[0]) =~ tr/_a-z0-9/_/cr}) || next; 541 | $generated_menu .= begin_category($schema->{cat}[1], ($with_icons ? $schema->{cat}[2] : ())) 542 | . join(q{}, 543 | map { $_->[1] } 544 | sort { $a->[0] cmp $b->[0] } 545 | map { [lc($_), $_] } 546 | map { prepare_item($_->{Exec}, $_->{Name}, $with_icons ? $_->{Icon} : ()) } @{$categories{$category}}) 547 | . "[end]\n"; 548 | } 549 | elsif (exists $schema->{item}) { 550 | $generated_menu .= prepare_item(@{$schema->{item}}); 551 | } 552 | elsif (exists $schema->{sep}) { 553 | $generated_menu .= "[separator]\n"; 554 | } 555 | elsif (exists $schema->{beg}) { 556 | $generated_menu .= begin_category(@{$schema->{beg}}); 557 | } 558 | elsif (exists $schema->{begin_cat}) { 559 | $generated_menu .= begin_category(@{$schema->{begin_cat}}); 560 | } 561 | elsif (exists $schema->{end}) { 562 | $generated_menu .= "[end]\n"; 563 | } 564 | elsif (exists $schema->{end_cat}) { 565 | $generated_menu .= "[end]\n"; 566 | } 567 | elsif (exists $schema->{raw}) { 568 | $generated_menu .= "$schema->{raw}\n"; 569 | } 570 | elsif (exists $schema->{fbmenugen}) { 571 | $generated_menu .= begin_category(@{$schema->{fbmenugen}}); 572 | require Cwd; 573 | foreach my $item ( 574 | [join(' ', $CONFIG{editor}, quotemeta(Cwd::abs_path($menu_file))), 'Menu file'], 575 | [join(' ', $CONFIG{editor}, quotemeta(Cwd::abs_path($config_file))), 'Config file'], 576 | [join(' ', $CONFIG{editor}, quotemeta(Cwd::abs_path($schema_file))), 'Schema file'], 577 | ) { 578 | $generated_menu .= prepare_item(@$item, $schema->{fbmenugen}[1]); 579 | } 580 | $generated_menu .= "[end]\n"; 581 | } 582 | elsif (exists $schema->{exit}) { 583 | my ($name, $icon) = @{$schema->{exit}}; 584 | if ($with_icons and (my $icon_path = check_icon($icon))) { 585 | $generated_menu .= < 587 | EXIT_WITH_ICON 588 | } 589 | else { 590 | $generated_menu .= <{regenerate}) { 596 | require Cwd; 597 | my $regenerate_exec = join( 598 | q{ }, $^X, quotemeta(Cwd::abs_path($0)), ($with_icons ? '-i' : ()), 599 | '-S' => quotemeta(Cwd::abs_path($schema_file)), 600 | '-C' => quotemeta(Cwd::abs_path($config_file)), 601 | '-o' => quotemeta(Cwd::abs_path($menu_file)), 602 | ); 603 | 604 | my ($label, $icon) = @{$schema->{regenerate}}; 605 | $generated_menu .= prepare_item($regenerate_exec, $label, $icon); 606 | } 607 | elsif (exists $schema->{fluxbox}) { 608 | my ($label, $icon) = 609 | ref $schema->{fluxbox} eq 'ARRAY' 610 | ? @{$schema->{fluxbox}} 611 | : $schema->{fluxbox}; 612 | 613 | $generated_menu .= begin_category(@{$schema->{fluxbox}}) . <<"FOOTER"; 614 | [config] (Configure) 615 | [submenu] (System Styles) {Choose a style...} 616 | [stylesdir] (/usr/share/fluxbox/styles) 617 | [end] 618 | [submenu] (User Styles) {Choose a style...} 619 | [stylesdir] (~/.fluxbox/styles) 620 | [end] 621 | [workspaces] (Workspace List) 622 | [submenu] (Tools) 623 | [exec] (Screenshot - JPG) {import screenshot.jpg && display -resize 50% screenshot.jpg} 624 | [exec] (Screenshot - PNG) {import screenshot.png && display -resize 50% screenshot.png} 625 | [exec] (Run) {fbrun} 626 | [exec] (Regen Menu) {fluxbox-generate_menu} 627 | [end] 628 | [commanddialog] (Fluxbox Command) 629 | [reconfig] (Reload config) 630 | [restart] (Restart) 631 | [exec] (About) {(fluxbox -v; fluxbox -info | sed 1d) | xmessage -file - -center} 632 | [separator] 633 | [exit] (Exit) 634 | [end] 635 | FOOTER 636 | } 637 | } 638 | 639 | $generated_menu .= "\n[endencoding]\n[end]\n"; 640 | 641 | if ($create_menu) { 642 | 643 | my $out_fh = $pipe ? \*STDOUT : do { 644 | open my $fh, '>', $menu_file 645 | or die "Can't open '${menu_file}' for write: $!"; 646 | $fh; 647 | }; 648 | 649 | print $out_fh $generated_menu; 650 | 651 | if (!$pipe) { 652 | print STDERR ":: A new menu has been successfully generated!\n"; 653 | } 654 | } 655 | else { 656 | print STDERR "[!] To generate a new menu, please specify option `-g`.\n"; 657 | } 658 | 659 | dump_configuration() if $update_config; 660 | 661 | dbmclose(%cache_db); 662 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------