├── po
├── LINGUAS
├── meson.build
└── POTFILES
├── .gitignore
├── data
├── yalter.BxtLauncher.desktop.in
├── yalter.BxtLauncher.appdata.xml.in
├── yalter.BxtLauncher.gschema.xml
└── meson.build
├── src
├── bxt_launcher.gresource.xml
├── meson.build
├── main.vala
├── process.vala
├── window.ui
├── system-monitor.vala
└── window.vala
├── meson.build
├── README.md
├── vapi
└── libgtop-2.0.vapi
└── COPYING
/po/LINGUAS:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /build*
2 | /install*
3 |
4 | # Glade
5 | *.ui~
6 |
--------------------------------------------------------------------------------
/po/meson.build:
--------------------------------------------------------------------------------
1 | i18n.gettext('bxt-launcher', preset: 'glib')
2 |
--------------------------------------------------------------------------------
/data/yalter.BxtLauncher.desktop.in:
--------------------------------------------------------------------------------
1 | [Desktop Entry]
2 | Name=Bunnymod XT Launcher
3 | Exec=bxt-launcher
4 | Terminal=false
5 | Type=Application
6 | Categories=GTK;
7 | StartupNotify=true
8 |
--------------------------------------------------------------------------------
/po/POTFILES:
--------------------------------------------------------------------------------
1 | data/yalter.BxtLauncher.desktop.in
2 | data/yalter.BxtLauncher.appdata.xml.in
3 | data/yalter.BxtLauncher.gschema.xml
4 | src/window.ui
5 | src/main.vala
6 | src/window.vala
7 |
8 |
--------------------------------------------------------------------------------
/src/bxt_launcher.gresource.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | window.ui
5 |
6 |
7 |
--------------------------------------------------------------------------------
/data/yalter.BxtLauncher.appdata.xml.in:
--------------------------------------------------------------------------------
1 |
2 |
3 | yalter.BxtLauncher.desktop
4 | CC0-1.0
5 | GPL-3.0-or-later
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/meson.build:
--------------------------------------------------------------------------------
1 | project('bxt-launcher', ['c', 'vala'],
2 | version: '0.1.0',
3 | meson_version: '>= 0.50.0',
4 | default_options: [ 'warning_level=2',
5 | ],
6 | )
7 |
8 | valac = meson.get_compiler('vala')
9 |
10 | vapi_dir = meson.current_source_dir() / 'vapi'
11 | add_project_arguments(['--vapidir', vapi_dir], language: 'vala')
12 |
13 | i18n = import('i18n')
14 |
15 |
16 | subdir('data')
17 | subdir('src')
18 | subdir('po')
19 |
20 | meson.add_install_script('build-aux/meson/postinstall.py')
21 |
--------------------------------------------------------------------------------
/src/meson.build:
--------------------------------------------------------------------------------
1 | bxt_launcher_sources = [
2 | 'main.vala',
3 | 'process.vala',
4 | 'system-monitor.vala',
5 | 'window.vala',
6 | ]
7 |
8 | bxt_launcher_deps = [
9 | dependency('glib-2.0', version: '>= 2.48'),
10 | dependency('gobject-2.0', version: '>= 2.48'),
11 | dependency('gio-2.0', version: '>= 2.48'),
12 | dependency('gtk+-3.0', version: '>= 3.18'),
13 | dependency('libgtop-2.0', version: '>= 2.32'),
14 | valac.find_library('posix'),
15 | ]
16 |
17 | gnome = import('gnome')
18 |
19 | bxt_launcher_sources += gnome.compile_resources('bxt_launcher-resources',
20 | 'bxt_launcher.gresource.xml',
21 | c_name: 'bxt_launcher'
22 | )
23 |
24 | executable('bxt-launcher', bxt_launcher_sources,
25 | dependencies: bxt_launcher_deps,
26 | install: true,
27 | )
28 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | # Bunnymod XT Launcher
4 |
5 | GUI launcher for [Bunnymod XT](https://github.com/YaLTeR/BunnymodXT) on Linux.
6 |
7 | ## Usage
8 |
9 | 1. Download the latest [release](https://github.com/YaLTeR/bxt-launcher/releases).
10 | 1. Extract all files from the archive.
11 | 1. Open bxt-launcher.
12 |
13 | ## Building
14 |
15 | You will need the Vala compiler and GTK libraries (GIO, GTK, libgtop).
16 |
17 | The launcher expects to find its GSettings schema and `libBunnymodXT.so` alongside its binary.
18 | Installing into a prefix without `DESTDIR` sets everything up:
19 |
20 | ```sh
21 | meson -Dprefix=$PWD/install build
22 | ninja -C build install
23 | # Copy libBunnymodXT.so into install/bin/ manually.
24 | # Then start the launcher:
25 | install/bin/bxt-launcher
26 | ```
27 |
--------------------------------------------------------------------------------
/src/main.vala:
--------------------------------------------------------------------------------
1 | /* main.vala
2 | *
3 | * Copyright 2020 Ivan Molodetskikh
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 |
19 | int main (string[] args) {
20 | var app = new Gtk.Application ("yalter.BxtLauncher", ApplicationFlags.FLAGS_NONE);
21 | app.activate.connect (() => {
22 | var win = app.active_window;
23 | if (win == null) {
24 | win = new BxtLauncher.Window (app);
25 | }
26 | win.present ();
27 | });
28 |
29 | return app.run (args);
30 | }
31 |
--------------------------------------------------------------------------------
/data/yalter.BxtLauncher.gschema.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | ""
7 | Path to the Half-Life root folder
8 |
9 | Path to the folder with the hl_linux binary and the mod folders
10 |
11 |
12 |
13 |
14 | ""
15 | LD_LIBRARY_PATH for launching Half-Life
16 |
17 | This is the value set by Steam when launching Half-Life normally.
18 |
19 |
20 |
21 |
22 | ""
23 | LD_PRELOAD for launching Half-Life
24 |
25 | This is the value set by Steam when launching Half-Life normally.
26 |
27 |
28 |
29 |
30 |
31 |
--------------------------------------------------------------------------------
/data/meson.build:
--------------------------------------------------------------------------------
1 | desktop_file = i18n.merge_file(
2 | input: 'yalter.BxtLauncher.desktop.in',
3 | output: 'yalter.BxtLauncher.desktop',
4 | type: 'desktop',
5 | po_dir: '../po',
6 | install: true,
7 | install_dir: join_paths(get_option('datadir'), 'applications')
8 | )
9 |
10 | desktop_utils = find_program('desktop-file-validate', required: false)
11 | if desktop_utils.found()
12 | test('Validate desktop file', desktop_utils,
13 | args: [desktop_file]
14 | )
15 | endif
16 |
17 | appstream_file = i18n.merge_file(
18 | input: 'yalter.BxtLauncher.appdata.xml.in',
19 | output: 'yalter.BxtLauncher.appdata.xml',
20 | po_dir: '../po',
21 | install: true,
22 | install_dir: join_paths(get_option('datadir'), 'appdata')
23 | )
24 |
25 | appstream_util = find_program('appstream-util', required: false)
26 | if appstream_util.found()
27 | test('Validate appstream file', appstream_util,
28 | args: ['validate', appstream_file]
29 | )
30 | endif
31 |
32 | install_data('yalter.BxtLauncher.gschema.xml',
33 | install_dir: join_paths(get_option('datadir'), 'glib-2.0/schemas')
34 | )
35 |
36 | compile_schemas = find_program('glib-compile-schemas', required: false)
37 | if compile_schemas.found()
38 | test('Validate schema file', compile_schemas,
39 | args: ['--strict', '--dry-run', meson.current_source_dir()]
40 | )
41 | endif
42 |
--------------------------------------------------------------------------------
/src/process.vala:
--------------------------------------------------------------------------------
1 | /* process.vala
2 | *
3 | * Copyright (C) 2020 Ivan Molodetskikh
4 | * Copyright (C) 2017 Red Hat, Inc.
5 | *
6 | * This program is free software: you can redistribute it and/or modify
7 | * it under the terms of the GNU General Public License as published by
8 | * the Free Software Foundation, either version 3 of the License, or
9 | * (at your option) any later version.
10 | *
11 | * This program is distributed in the hope that it will be useful,
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | * GNU General Public License for more details.
15 | *
16 | * You should have received a copy of the GNU General Public License
17 | * along with this program. If not, see .
18 | *
19 | * Authors: Petr Štětka
20 | */
21 |
22 | namespace BxtLauncher
23 | {
24 | public class Process : Object
25 | {
26 | public Pid pid { get; private set; }
27 | public string cmdline { get; private set; }
28 | public uint uid { get; private set; }
29 | public uint64 start_time { get; set; default = 0; }
30 |
31 | public Process(Pid pid)
32 | {
33 | this.pid = pid;
34 | this.cmdline = get_full_process_cmd (pid);
35 | this.uid = _get_uid ();
36 | this.start_time = _get_start_time ();
37 | }
38 |
39 | private uint _get_uid()
40 | {
41 | GTop.ProcUid procUid;
42 | GTop.get_proc_uid(out procUid, pid);
43 | return procUid.uid;
44 | }
45 |
46 | private uint64 _get_start_time()
47 | {
48 | GTop.ProcTime proc_time;
49 | GTop.get_proc_time (out proc_time, pid);
50 | return proc_time.start_time;
51 | }
52 |
53 | public HashTable get_env () throws Error
54 | {
55 | var file = File.new_for_path (@"/proc/$pid/environ");
56 | var env = new HashTable (str_hash, str_equal);
57 |
58 | uint8[] data;
59 | string etag_out;
60 | file.load_contents (null, out data, out etag_out);
61 |
62 | var start = 0;
63 | for (int i = 0; i < data.length; i++) {
64 | if (data[i] == 0) {
65 | var v = (string) data[start:i];
66 | var kv = v.split ("=", 2);
67 | env[kv[0]] = kv[1];
68 | start = i + 1;
69 | }
70 | }
71 |
72 | return env;
73 | }
74 |
75 | /* static pid related methods */
76 | public static string get_full_process_cmd (Pid pid) {
77 | GTop.ProcArgs proc_args;
78 | GTop.ProcState proc_state;
79 | string[] args = GTop.get_proc_argv (out proc_args, pid, 0);
80 | GTop.get_proc_state (out proc_state, pid);
81 | string cmd = (string) proc_state.cmd;
82 |
83 | /* cmd is most likely a truncated version, therefore
84 | * we check the first two arguments of the full argv
85 | * vector if they match cmd and if so, use that */
86 | for (int i = 0; i < 2; i++) {
87 | if (args[i] == null)
88 | continue;
89 |
90 | /* TODO: this will fail if args[i] is a commandline,
91 | * i.e. composed of multiple segments and one of the
92 | * later ones is a unix path */
93 | var name = Path.get_basename (args[i]);
94 | if (!name.has_prefix (cmd))
95 | continue;
96 |
97 | name = Process.first_component (name);
98 | return Process.sanitize_name (name);
99 | }
100 |
101 | return Process.sanitize_name (cmd);
102 | }
103 |
104 | /* static utility methods */
105 | public static string? sanitize_name (string name) {
106 | string? result = null;
107 |
108 | if (name == null)
109 | return null;
110 |
111 | try {
112 | var rgx = new Regex ("[^a-zA-Z0-9._-]");
113 | result = rgx.replace (name, name.length, 0, "");
114 | } catch (RegexError e) {
115 | warning ("Unable to sanitize name: %s", e.message);
116 | }
117 |
118 | return result;
119 | }
120 |
121 | public static string first_component (string str) {
122 |
123 | for (int i = 0; i < str.length; i++) {
124 | if (str[i] == ' ') {
125 | return str.substring(0, i);
126 | }
127 | }
128 |
129 | return str;
130 | }
131 | }
132 | }
133 |
--------------------------------------------------------------------------------
/src/window.ui:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | False
7 | 600
8 | 300
9 |
10 |
108 |
109 |
110 |
111 | True
112 | False
113 | Bunnymod XT Launcher
114 | False
115 | True
116 |
117 |
118 |
119 |
120 |
--------------------------------------------------------------------------------
/src/system-monitor.vala:
--------------------------------------------------------------------------------
1 | /* system-monitor.vala
2 | *
3 | * Copyright (C) 2020 Ivan Molodetskikh
4 | * Copyright (C) 2017 Red Hat, Inc.
5 | *
6 | * This program is free software: you can redistribute it and/or modify
7 | * it under the terms of the GNU General Public License as published by
8 | * the Free Software Foundation, either version 3 of the License, or
9 | * (at your option) any later version.
10 | *
11 | * This program is distributed in the hope that it will be useful,
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 | * GNU General Public License for more details.
15 | *
16 | * You should have received a copy of the GNU General Public License
17 | * along with this program. If not, see .
18 | *
19 | * Authors: Petr Štětka
20 | */
21 |
22 | namespace BxtLauncher
23 | {
24 | public class SystemMonitor : Object
25 | {
26 | const int UPDATE_INTERVAL = 1000;
27 |
28 | private HashTable process_table;
29 | private int process_mode = GTop.KERN_PROC_ALL;
30 | private static SystemMonitor system_monitor;
31 |
32 | public signal void on_process_added (Process process);
33 | public signal void on_process_removed (Process process);
34 |
35 | public static SystemMonitor get_default()
36 | {
37 | if (system_monitor == null)
38 | system_monitor = new SystemMonitor ();
39 |
40 | return system_monitor;
41 | }
42 |
43 | private SystemMonitor()
44 | {
45 | GTop.init();
46 |
47 | process_table = new HashTable(direct_hash, direct_equal);
48 |
49 | update_data();
50 | Timeout.add(UPDATE_INTERVAL, update_data);
51 | }
52 |
53 | public Process? find_process (string cmdline) {
54 | return process_table.find ((pid, process) => {
55 | return process.cmdline == cmdline;
56 | });
57 | }
58 |
59 | private bool update_data()
60 | {
61 | /* Try to find the difference between the old list of pids,
62 | * and the new ones, i.e. the one that got added and removed */
63 | GTop.Proclist proclist;
64 | var pids = GTop.get_proclist (out proclist, process_mode);
65 | var old = (ssize_t[]) process_table.get_keys_as_array ();
66 |
67 | size_t new_len = (size_t) proclist.number;
68 | size_t old_len = process_table.length;
69 |
70 | sort_pids (pids, sizeof (GLib.Pid), new_len);
71 | sort_pids (old, sizeof (ssize_t), old_len);
72 |
73 | debug ("new_len: %lu, old_len: %lu\n", new_len, old_len);
74 | uint removed = 0;
75 | uint added = 0;
76 | for (size_t i = 0, j = 0; i < new_len || j < old_len; ) {
77 | uint32 n = i < new_len ? pids[i] : uint32.MAX;
78 | uint32 o = j < old_len ? (uint32) old[j] : uint32.MAX;
79 |
80 | /* pids: [ 1, 3, 4 ]
81 | * old: [ 1, 2, 4, 5 ] → 2,5 removed, 3 added
82 | * i [for pids]: 0 | 1 | 1 | 2 | 3
83 | * j [for old]: 0 | 1 | 2 | 2 | 3
84 | * n = pids[i]: 1 | 3 | 3 | 4 | MAX [oob]
85 | * o = old[j]: 1 | 2 | 4 | 4 | 5
86 | * = | n > o | n < o | = | n > o
87 | * increment: i,j | j | i | i,j | j
88 | * Process op: chk | del | add | chk | del
89 | */
90 |
91 | if (n > o) {
92 | /* delete to process not in the new array */
93 | Process p = process_table[(GLib.Pid) o];
94 | debug ("process removed: %u\n", o);
95 |
96 | process_removed (p);
97 | removed++;
98 |
99 | j++; /* let o := old[j] catch up */
100 | } else if (n < o) {
101 | /* new process */
102 | var p = new Process ((GLib.Pid) n);
103 |
104 | debug ("process added: %u\n", n);
105 |
106 | process_added (p);
107 | added++;
108 |
109 | i++; /* let n := pids[i] catch up */
110 | } else {
111 | /* equal pids, might have rolled over though
112 | * better check, match start time */
113 | Process p = process_table[(GLib.Pid) n];
114 |
115 | GTop.ProcTime ptime;
116 | GTop.get_proc_time (out ptime, p.pid);
117 |
118 | /* no match: -> old removed, new added */
119 | if (ptime.start_time != p.start_time) {
120 | debug ("start time mismtach: %u\n", n);
121 | process_removed (p);
122 |
123 | p = new Process ((GLib.Pid) n);
124 | process_added (p);
125 | }
126 |
127 | i++; j++; /* both indices move */
128 | }
129 | }
130 |
131 | debug ("removed: %u, added: %u\n", removed, added);
132 | debug ("process table size: %u\n", process_table.length);
133 |
134 | return true;
135 | }
136 |
137 | private void process_added (Process p) {
138 | process_table.insert (p.pid, p);
139 | on_process_added (p);
140 | }
141 |
142 | private void process_removed (Process p) {
143 | process_table.remove (p.pid);
144 | on_process_removed (p);
145 | }
146 |
147 | public static void sort_pids (void *pids, size_t elm, size_t length)
148 | {
149 | Posix.qsort (pids, length, elm, (a, b) => {
150 | return (*(GLib.Pid *) a) - (* (GLib.Pid *) b);
151 | });
152 | }
153 | }
154 | }
155 |
--------------------------------------------------------------------------------
/vapi/libgtop-2.0.vapi:
--------------------------------------------------------------------------------
1 | [CCode(cheader_filename = "glibtop.h", lower_case_cprefix = "glibtop_")]
2 | namespace GTop {
3 |
4 | public void init();
5 |
6 | [CCode(cname = "glibtop_cpu", cheader_filename = "glibtop/cpu.h")]
7 | public struct Cpu {
8 | uint64 flags;
9 | uint64 total;
10 | uint64 user;
11 | uint64 nice;
12 | uint64 sys;
13 | uint64 idle;
14 | uint64 iowait;
15 | uint64 irq;
16 | uint64 softirq;
17 | uint64 frequency;
18 | uint64 xcpu_total[1024];
19 | uint64 xcpu_user[1024];
20 | uint64 xcpu_nice[1024];
21 | uint64 xcpu_sys[1024];
22 | uint64 xcpu_idle[1024];
23 | uint64 xcpu_iowait[1024];
24 | uint64 xcpu_irq[1024];
25 | uint64 xcpu_softirq[1024];
26 | uint64 xcpu_flags;
27 | }
28 | public void get_cpu(out Cpu cpu);
29 |
30 | [CCode(cname = "GLIBTOP_KERN_PROC_ALL")]
31 | public const int KERN_PROC_ALL;
32 | [CCode(cname = "GLIBTOP_KERN_PROC_PID")]
33 | public const int KERN_PROC_PID;
34 | [CCode(cname = "GLIBTOP_KERN_PROC_PGRP")]
35 | public const int KERN_PROC_PRGP;
36 | [CCode(cname = "GLIBTOP_KERN_PROC_SESSION")]
37 | public const int KERN_PROC_SESSION;
38 | [CCode(cname = "GLIBTOP_KERN_PROC_TTY")]
39 | public const int KERN_PROC_TTY;
40 | [CCode(cname = "GLIBTOP_KERN_PROC_UID")]
41 | public const int KERN_PROC_UID;
42 | [CCode(cname = "GLIBTOP_KERN_PROC_RUID")]
43 | public const int KERN_PROC_RUID;
44 | [CCode(cname = "GLIBTOP_KERN_PROC_MASK")]
45 | public const int KERN_PROC_MASK;
46 | [CCode(cname = "GLIBTOP_EXCLUDE_IDLE")]
47 | public const int EXCLUDE_IDLE;
48 | [CCode(cname = "GLIBTOP_EXCLUDE_SYSTEM")]
49 | public const int EXCLUDE_SYSTEM;
50 |
51 | [CCode(cname = "glibtop_proclist", cheader_filename = "glibtop/proclist.h")]
52 | public struct Proclist {
53 | uint64 flags;
54 | uint64 number;
55 | uint64 total;
56 | uint64 size;
57 | }
58 | [CCode(array_length = false, array_null_terminated = false)]
59 | public GLib.Pid[] get_proclist(out Proclist proclist, uint64 which, uint64? arg = null);
60 |
61 | [CCode(cname = "glibtop_proc_state", cheader_filename = "glibtop/procstate.h")]
62 | public struct ProcState {
63 | uint64 flags;
64 | char cmd[40];
65 | uint state;
66 | int uid;
67 | int gid;
68 | int ruid;
69 | int rgid;
70 | int has_cpu;
71 | int processor;
72 | int last_processor;
73 | }
74 | public void get_proc_state(out ProcState proc_state, GLib.Pid pid);
75 |
76 | [CCode(cname = "GLIBTOP_PROCESS_RUNNING")]
77 | public const int PROCESS_RUNNING;
78 | [CCode(cname = "GLIBTOP_PROCESS_INTERRUPTIBLE")]
79 | public const int PROCESS_INTERRUPTIBLE;
80 | [CCode(cname = "GLIBTOP_PROCESS_UNINTERRUPTIBLE")]
81 | public const int PROCESS_UNINTERRUPTIBLE;
82 | [CCode(cname = "GLIBTOP_PROCESS_ZOMBIE")]
83 | public const int PROCESS_ZOMBIE;
84 | [CCode(cname = "GLIBTOP_PROCESS_STOPPED")]
85 | public const int PROCESS_STOPPED;
86 | [CCode(cname = "GLIBTOP_PROCESS_SWAPPING")]
87 | public const int PROCESS_SWAPPING;
88 | [CCode(cname = "GLIBTOP_PROCESS_DEAD")]
89 | public const int PROCESS_DEAD;
90 |
91 | [CCode(cname = "glibtop_proc_time", cheader_filename = "glibtop/proctime.h")]
92 | public struct ProcTime {
93 | uint64 flags;
94 | uint64 start_time;
95 | uint64 rtime;
96 | uint64 utime;
97 | uint64 stime;
98 | uint64 cutime;
99 | uint64 cstime;
100 | uint64 timeout;
101 | uint64 it_real_value;
102 | uint64 frequency;
103 | uint64 xcpu_utime[1024];
104 | uint64 xcpu_stime[1024];
105 | }
106 | public void get_proc_time(out ProcTime proc_time, GLib.Pid pid);
107 |
108 | [CCode(cname = "glibtop_mem", cheader_filename = "glibtop/mem.h")]
109 | public struct Mem {
110 | uint64 flags;
111 | uint64 total;
112 | uint64 used;
113 | uint64 free;
114 | uint64 shared;
115 | uint64 buffer;
116 | uint64 cached;
117 | uint64 user;
118 | uint64 locked;
119 | }
120 | public void get_mem(out Mem mem);
121 |
122 | [CCode(cname = "glibtop_swap", cheader_filename = "glibtop/swap.h")]
123 | public struct Swap {
124 | uint64 flags;
125 | uint64 total;
126 | uint64 used;
127 | uint64 free;
128 | uint64 pagein;
129 | uint64 pageout;
130 | }
131 | public void get_swap(out Swap swap);
132 |
133 | [CCode(cname = "glibtop_proc_mem", cheader_filename = "glibtop/procmem.h")]
134 | public struct ProcMem {
135 | uint64 flags;
136 | uint64 size;
137 | uint64 vsize;
138 | uint64 resident;
139 | uint64 share;
140 | uint64 rss;
141 | uint64 rss_rlim;
142 | }
143 | public void get_proc_mem(out ProcMem proc_mem, GLib.Pid pid);
144 |
145 | [CCode(cname = "glibtop_netlist", cheader_filename = "glibtop/netlist.h")]
146 | public struct Netlist {
147 | uint64 flags;
148 | uint32 number;
149 | }
150 |
151 | [CCode(array_null_terminated = "true")]
152 | public string[] get_netlist(out Netlist netlist);
153 |
154 | [CCode(cname = "glibtop_proc_uid", cheader_filename = "glibtop/procuid.h")]
155 | public struct ProcUid {
156 | uint64 flags;
157 | int32 uid;
158 | int32 euid;
159 | int32 gid;
160 | int32 egid;
161 | int32 suid;
162 | int32 sgid;
163 | int32 fsuid;
164 | int32 fsgid;
165 | int32 pid;
166 | int32 ppid;
167 | int32 pgrp;
168 | int32 session;
169 | int32 tty;
170 | int32 tpgid;
171 | int32 priority;
172 | int32 nice;
173 | int32 ngroups;
174 | int32 groups[64];
175 | }
176 | public void get_proc_uid(out ProcUid proc_uid, GLib.Pid pid);
177 |
178 | [CCode(cname = "glibtop_proc_args", cheader_filename = "glibtop/procargs.h")]
179 | public struct ProcArgs {
180 | uint64 flags;
181 | uint64 size;
182 | }
183 | [CCode (array_length = false, array_null_terminated = true)]
184 | public string[] get_proc_argv(out ProcArgs proc_args, GLib.Pid pid, uint length);
185 |
186 | [CCode(cname = "glibtop_fsusage", cheader_filename = "glibtop/fsusage.h")]
187 | public struct FsUsage {
188 | uint64 flags;
189 | uint64 blocks;
190 | uint64 bfree;
191 | uint64 bavail;
192 | uint64 files;
193 | uint64 ffree;
194 | uint32 block_size;
195 | uint64 read;
196 | uint64 write;
197 | }
198 | public void get_fsusage(out FsUsage fs_usage, string mount_dir);
199 |
200 | [CCode(cname = "glibtop_mountentry", cheader_filename = "glibtop/mountlist.h", destroy_function="g_free")]
201 | public struct MountEntry
202 | {
203 | uint64 dev;
204 | char devname[80];
205 | char mountdir[80];
206 | char type[80];
207 | }
208 |
209 | [CCode(cname = "glibtop_mountlist", cheader_filename = "glibtop/mountlist.h")]
210 | public struct MountList
211 | {
212 | uint64 flags;
213 | uint64 number;
214 | uint64 total;
215 | uint64 size;
216 | }
217 | [CCode(array_length = false)]
218 | public MountEntry[] get_mountlist(out MountList mount_list, bool all_fs);
219 | }
220 |
--------------------------------------------------------------------------------
/src/window.vala:
--------------------------------------------------------------------------------
1 | /* window.vala
2 | *
3 | * Copyright 2020 Ivan Molodetskikh
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 | namespace BxtLauncher {
19 | [GtkTemplate (ui = "/yalter/BxtLauncher/window.ui")]
20 | public class Window : Gtk.ApplicationWindow {
21 | private Settings settings;
22 |
23 | private string? bxt_path { get; set; }
24 |
25 | private Gtk.MessageDialog? dialog { get; set; }
26 |
27 | [GtkChild]
28 | private unowned Gtk.ComboBoxText mod_combo_box;
29 |
30 | public Window (Gtk.Application app) {
31 | Object (application: app);
32 |
33 | settings = null;
34 | bxt_path = null;
35 | dialog = null;
36 |
37 | string path;
38 | try {
39 | path = FileUtils.read_link ("/proc/self/exe");
40 | } catch (FileError e) {
41 | fatal_error (@"Could not get the launcher executable path.\n\n$(e.message)");
42 | return;
43 | }
44 |
45 | path = Path.get_dirname (path);
46 | bxt_path = Path.build_filename (path, "libBunnymodXT.so");
47 |
48 | try {
49 | var source = new SettingsSchemaSource.from_directory (path, null, false);
50 | var schema = source.lookup ("yalter.BxtLauncher", false);
51 | settings = new Settings.full (schema, null, null);
52 | } catch (Error e) {
53 | fatal_error (@"Could not open the settings schema. Make sure the gschemas.compiled file is in the same folder as the launcher.\n\n$(e.message)");
54 | return;
55 | }
56 |
57 | detect_mod_folders.begin ();
58 | }
59 |
60 | private async void detect_mod_folders () {
61 | var hl_pwd = settings.get_string ("hl-pwd");
62 | if (hl_pwd == "") {
63 | return;
64 | }
65 |
66 | var hl_dir = File.new_for_path (hl_pwd);
67 |
68 | var mod_folders = new HashTable (str_hash, str_equal);
69 |
70 | try {
71 | var enumerator = yield hl_dir.enumerate_children_async (
72 | "standard::type,standard::name,standard::display-name",
73 | FileQueryInfoFlags.NONE
74 | );
75 |
76 | while (true) {
77 | var files = yield enumerator.next_files_async (100);
78 | if (files.length () == 0) {
79 | break;
80 | }
81 |
82 | foreach (var file in files) {
83 | if (file.get_file_type () != FileType.DIRECTORY) {
84 | continue;
85 | }
86 |
87 | string? name;
88 | if (yield is_mod_folder (hl_dir.get_child (file.get_name ()), out name)) {
89 | mod_folders[file.get_name ()] =
90 | (name != null) ? name : file.get_display_name ();
91 | }
92 | }
93 | }
94 | } catch (Error _) {
95 | // Proceed on any errors, the code below handles this case.
96 | }
97 |
98 | mod_combo_box.remove_all ();
99 | if (mod_folders.size () == 0) {
100 | mod_combo_box.append ("valve", "Half-Life");
101 | mod_combo_box.append ("gearbox", "Opposing Force");
102 | mod_combo_box.append ("bshift", "Blue Shift");
103 | mod_combo_box.append ("cstrike", "Counter-Strike");
104 | mod_combo_box.append ("czero", "Counter-Strike: Condition Zero");
105 | mod_combo_box.append ("czeror", "Counter-Strike: Condition Zero Deleted Scenes");
106 | mod_combo_box.append ("tfc", "Team Fortress Classic");
107 | mod_combo_box.append ("dod", "Day of Defeat");
108 | mod_combo_box.append ("dmc", "Deathmatch Classic");
109 | mod_combo_box.append ("ricochet", "Ricochet");
110 | mod_combo_box.append ("ag", "OpenAG");
111 | mod_combo_box.set_active_id ("valve");
112 | } else {
113 | string? first = null;
114 | mod_folders.foreach((id, name) => {
115 | if (first == null) {
116 | first = id;
117 | }
118 |
119 | if (id == "valve") {
120 | mod_combo_box.prepend (id, name);
121 | first = id;
122 | } else {
123 | mod_combo_box.append (id, name);
124 | }
125 | });
126 |
127 | mod_combo_box.set_active_id (first);
128 | }
129 | }
130 |
131 | private async bool is_mod_folder (File folder, out string? name) {
132 | name = null;
133 | var liblist = folder.get_child ("liblist.gam");
134 |
135 | FileInputStream fis;
136 | try {
137 | fis = yield liblist.read_async ();
138 | } catch (Error _) {
139 | // For example, if liblist.gam does not exist.
140 | return false;
141 | }
142 |
143 | try {
144 | var dis = new DataInputStream (fis);
145 |
146 | string? line;
147 | while ((line = yield dis.read_line_utf8_async (Priority.DEFAULT, null, null)) != null) {
148 | if (line.length < 4 || line[0:4].ascii_casecmp ("game") != 0) {
149 | continue;
150 | }
151 |
152 | var first_quote = line.index_of_char ('"');
153 | if (first_quote == -1) {
154 | break;
155 | }
156 |
157 | var second_quote = line.index_of_char ('"', first_quote + 1);
158 | if (second_quote == -1) {
159 | break;
160 | }
161 |
162 | name = line[first_quote + 1:second_quote];
163 | break;
164 | }
165 | } catch (Error _) {
166 | // If we couldn't get the display name just return true, it'll use the folder name.
167 | }
168 |
169 | return true;
170 | }
171 |
172 | [GtkCallback]
173 | private void launch_button_clicked_cb (Gtk.Button button) {
174 | var hl_pwd = settings.get_string ("hl-pwd");
175 |
176 | if (hl_pwd == "") {
177 | get_hl_environment ();
178 | } else {
179 | launch_hl (hl_pwd);
180 | }
181 | }
182 |
183 | private void close_dialog () {
184 | if (dialog == null)
185 | return;
186 |
187 | dialog.destroy ();
188 | dialog = null;
189 | }
190 |
191 | private void fatal_error (string message) {
192 | var dialog = new Gtk.MessageDialog (
193 | this,
194 | Gtk.DialogFlags.DESTROY_WITH_PARENT,
195 | Gtk.MessageType.ERROR,
196 | Gtk.ButtonsType.OK,
197 | "Fatal Error"
198 | );
199 | dialog.secondary_text = message;
200 | dialog.run ();
201 | application.quit ();
202 | }
203 |
204 | private void show_error_dialog (string message, string secondary) {
205 | var dialog = new Gtk.MessageDialog (
206 | this,
207 | Gtk.DialogFlags.MODAL | Gtk.DialogFlags.DESTROY_WITH_PARENT,
208 | Gtk.MessageType.ERROR,
209 | Gtk.ButtonsType.OK,
210 | message
211 | );
212 | dialog.secondary_text = secondary;
213 | dialog.response.connect ((dialog, response) => dialog.destroy ());
214 | dialog.show ();
215 | }
216 |
217 | private void get_hl_environment () {
218 | var monitor = SystemMonitor.get_default ();
219 |
220 | // Check if Half-Life is already running.
221 | var hl = monitor.find_process ("hl_linux");
222 | if (hl != null) {
223 | var dialog = new Gtk.MessageDialog (
224 | this,
225 | Gtk.DialogFlags.DESTROY_WITH_PARENT,
226 | Gtk.MessageType.INFO,
227 | Gtk.ButtonsType.OK_CANCEL,
228 | "Half-Life is Already Running"
229 | );
230 | dialog.secondary_text = "Half-Life will be closed and started again.";
231 | var response = dialog.run ();
232 | dialog.destroy ();
233 |
234 | if (response == Gtk.ResponseType.OK) {
235 | extract_environment_and_launch_hl (hl);
236 | }
237 |
238 | return;
239 | }
240 |
241 | monitor.on_process_added.connect (process_added_cb);
242 |
243 | try {
244 | string[] spawn_args = {"steam", "steam://rungameid/70"};
245 |
246 | GLib.Process.spawn_async (
247 | null,
248 | spawn_args,
249 | null,
250 | SpawnFlags.SEARCH_PATH,
251 | null,
252 | null
253 | );
254 | } catch (SpawnError e) {
255 | show_error_dialog (
256 | "Failed to Run Half-Life",
257 | @"Make sure that Steam is installed.\n\n$(e.message)"
258 | );
259 | return;
260 | }
261 |
262 | // Spawn a dialog to let the user know what's happening.
263 | dialog = new Gtk.MessageDialog (
264 | this,
265 | Gtk.DialogFlags.MODAL | Gtk.DialogFlags.DESTROY_WITH_PARENT,
266 | Gtk.MessageType.INFO,
267 | Gtk.ButtonsType.CANCEL,
268 | "Configuring Launch Parameters"
269 | );
270 | dialog.secondary_text = "Half-Life will open and then close.";
271 | dialog.response.connect (close_dialog);
272 | dialog.show ();
273 | }
274 |
275 | private void process_added_cb (SystemMonitor monitor, Process process) {
276 | if (process.cmdline == "hl_linux") {
277 | monitor.on_process_added.disconnect (process_added_cb);
278 |
279 | extract_environment_and_launch_hl (process);
280 | }
281 | }
282 |
283 | private void extract_environment_and_launch_hl (Process process)
284 | requires (process.cmdline == "hl_linux")
285 | {
286 | string hl_pwd = "";
287 |
288 | try {
289 | var env = process.get_env ();
290 |
291 | if (!env.contains ("PWD")) {
292 | close_dialog ();
293 |
294 | show_error_dialog (
295 | "Failed to Configure Launch Parameters",
296 | "Half-Life environment doesn't contain PWD."
297 | );
298 | } else {
299 | hl_pwd = env["PWD"];
300 | settings.set_string ("hl-pwd", hl_pwd);
301 | settings.set_string ("hl-ld-library-path", env["LD_LIBRARY_PATH"]);
302 | settings.set_string ("hl-ld-preload", env["LD_PRELOAD"]);
303 |
304 | var monitor = SystemMonitor.get_default ();
305 | monitor.on_process_removed.connect (process_removed_cb);
306 | }
307 | } catch (Error e) {
308 | close_dialog ();
309 |
310 | show_error_dialog (
311 | "Failed to Configure Launch Parameters",
312 | @"Could not read the Half-Life environment.\n\n$(e.message)"
313 | );
314 | }
315 |
316 | // Close this Half-Life instance.
317 | #if VALA_0_40
318 | var sigterm = Posix.Signal.TERM;
319 | #else
320 | var sigterm = Posix.SIGTERM;
321 | #endif
322 | Posix.kill (process.pid, sigterm);
323 | }
324 |
325 | private void process_removed_cb (SystemMonitor monitor, Process process) {
326 | if (process.cmdline == "hl_linux") {
327 | monitor.on_process_removed.disconnect (process_removed_cb);
328 |
329 | close_dialog ();
330 |
331 | var hl_pwd = settings.get_string ("hl-pwd");
332 | if (hl_pwd != "") {
333 | launch_hl (hl_pwd);
334 |
335 | // Update mod folders afterwards because it resets the selected mod.
336 | detect_mod_folders.begin ();
337 | }
338 | }
339 | }
340 |
341 | private void launch_hl (string hl_pwd)
342 | requires (bxt_path != null)
343 | requires (hl_pwd != "")
344 | {
345 | // Check that libBunnymodXT.so is present.
346 | var bxt = File.new_for_path (bxt_path);
347 | if (!bxt.query_exists ()) {
348 | show_error_dialog (
349 | "Bunnymod XT is Missing",
350 | @"Make sure that libBunnymodXT.so is in the same folder as the launcher: $(Path.get_dirname (bxt_path))"
351 | );
352 | return;
353 | }
354 |
355 | string[] spawn_args = {"./hl_linux", "-steam", "-game", mod_combo_box.get_active_id ()};
356 | string[] spawn_env = Environ.get ();
357 |
358 | var hl_ld_library_path = settings.get_string ("hl-ld-library-path");
359 |
360 | // Add BXT in the end: gameoverlayrenderer really doesn't like being after BXT.
361 | var ld_preload = "";
362 | // TODO: gameoverlayrenderer seems to override dlsym(), which prevents BXT from doing
363 | // the same, which results in some mod client libraries not being hooked (notably, the
364 | // Opposing Force one). So, don't use the Steam LD_PRELOAD until this is resolved in
365 | // BXT.
366 | //
367 | // var hl_ld_preload = settings.get_string ("hl-ld-preload");
368 | // if (hl_ld_preload != "") {
369 | // ld_preload += @"$hl_ld_preload:";
370 | // }
371 | ld_preload += bxt_path;
372 |
373 | bool found_pwd = false, found_ld_library_path = false, found_ld_preload = false, found_steam_env = false;
374 | for (int i = 0; i < spawn_env.length; i++) {
375 | var v = spawn_env[i];
376 |
377 | if (v.has_prefix ("PWD=")) {
378 | found_pwd = true;
379 | spawn_env[i] = @"PWD=$hl_pwd";
380 | }
381 |
382 | if (v.has_prefix ("LD_LIBRARY_PATH=")) {
383 | found_ld_library_path = true;
384 | if (hl_ld_library_path != "") {
385 | spawn_env[i] = @"LD_LIBRARY_PATH=$hl_ld_library_path";
386 | }
387 | }
388 |
389 | if (v.has_prefix ("LD_PRELOAD=")) {
390 | found_ld_preload = true;
391 | spawn_env[i] = @"LD_PRELOAD=$ld_preload";
392 | }
393 |
394 | if (v.has_prefix ("SteamEnv=")) {
395 | found_steam_env = true;
396 | }
397 | }
398 |
399 | if (!found_pwd) {
400 | spawn_env += @"PWD=$hl_pwd";
401 | }
402 | if (!found_ld_library_path && hl_ld_library_path != "") {
403 | spawn_env += @"LD_LIBRARY_PATH=$hl_ld_library_path";
404 | }
405 | if (!found_ld_preload) {
406 | spawn_env += @"LD_PRELOAD=$ld_preload";
407 | }
408 | if (!found_steam_env) {
409 | spawn_env += @"SteamEnv=1";
410 | }
411 |
412 | debug (@"Spawning:\n\tworking_directory = $hl_pwd\n\targv = $(string.joinv(", ", spawn_args))\n\tenvp =\n\t\t$(string.joinv("\n\t\t", spawn_env))\n");
413 |
414 | try {
415 | GLib.Process.spawn_async (
416 | hl_pwd,
417 | spawn_args,
418 | spawn_env,
419 | 0,
420 | null,
421 | null
422 | );
423 | } catch (SpawnError e) {
424 | show_error_dialog (
425 | "Failed to Run Half-Life",
426 | @"Please try again. The launch parameters will be re-configured.\n\n$(e.message)"
427 | );
428 |
429 | // Resetting hl-pwd triggers the re-configure.
430 | settings.set_string ("hl-pwd", "");
431 |
432 | return;
433 | }
434 | }
435 | }
436 | }
437 |
--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
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 |
635 | Copyright (C)
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 | Copyright (C)
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 |
676 |
--------------------------------------------------------------------------------