├── src ├── ValaGist.vala ├── Profile.vala ├── Errors.vala ├── meson.build ├── GistFile.vala ├── OtherProfile.vala ├── MyProfile.vala └── Gist.vala ├── .gitignore ├── meson └── post_install.py ├── tests ├── meson.build └── vala-gist-test.vala ├── uninstall.sh ├── meson.build ├── README.md └── COPYING /src/ValaGist.vala: -------------------------------------------------------------------------------- 1 | namespace ValaGist {} 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | temp/ 3 | src/make.sh 4 | -------------------------------------------------------------------------------- /meson/post_install.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | -------------------------------------------------------------------------------- /tests/meson.build: -------------------------------------------------------------------------------- 1 | test('vala-gist-test', executable('vala-gist-test', ['vala-gist-test.vala'], dependencies: deps + [valagist_dep])) 2 | 3 | -------------------------------------------------------------------------------- /tests/vala-gist-test.vala: -------------------------------------------------------------------------------- 1 | using ValaGist; 2 | 3 | public int main (string[] args) { 4 | OtherProfile user = new OtherProfile("rickybassom", false); 5 | // TODO: implement server mocking 6 | return 0; 7 | } 8 | -------------------------------------------------------------------------------- /uninstall.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | sudo rm /usr/lib64/libvalagist-1.0.so 4 | sudo rm /usr/lib64/pkgconfig/valagist-1.0.pc 5 | sudo rm /usr/local/share/vala/vapi/valagist-1.0.vapi 6 | sudo rm /usr/local/include/valagist-1.0.h 7 | -------------------------------------------------------------------------------- /src/Profile.vala: -------------------------------------------------------------------------------- 1 | namespace ValaGist { 2 | 3 | public interface Profile : Object { 4 | public abstract string id { get; internal set; } 5 | public abstract string name { get; internal set; } 6 | internal abstract GenericArray internal_gists { get; set; } 7 | 8 | public abstract Gist[] list_all(); 9 | 10 | } 11 | 12 | } 13 | -------------------------------------------------------------------------------- /meson.build: -------------------------------------------------------------------------------- 1 | project('vala-gist', ['vala', 'c'], 2 | version: '1.0.0-dev', 3 | license: 'GNU') 4 | 5 | glib = dependency('glib-2.0', version: '>=2.32') 6 | gobject = dependency('gobject-2.0', version: '>=2.32') 7 | gmodule = dependency('gmodule-2.0', version: '>=2.32') 8 | gio = dependency('gio-2.0', version: '>=2.32') 9 | gio_unix = dependency('gio-unix-2.0', version: '>=2.40') 10 | json_glib = dependency('json-glib-1.0', version: '>=1.0') 11 | libsoup = dependency('libsoup-2.4', version: '>=2.4') 12 | 13 | deps = [ 14 | glib, 15 | gobject, 16 | gmodule, 17 | gio, 18 | gio_unix, 19 | json_glib, 20 | libsoup 21 | ] 22 | 23 | subdir('src') 24 | subdir('tests') 25 | -------------------------------------------------------------------------------- /src/Errors.vala: -------------------------------------------------------------------------------- 1 | namespace ValaGist { 2 | 3 | public errordomain Error { 4 | NULL, 5 | FAILED, 6 | INVALID, 7 | TYPE 8 | } 9 | 10 | // collection of types of errors associated with the program 11 | internal class Errors { 12 | public static void incorrect_token(uint error_code) throws ValaGist.Error { 13 | throw new Error.FAILED("Invalid token, error from github. \nError code: " + error_code.to_string()); 14 | } 15 | public static void other_network(uint error_code) throws ValaGist.Error { 16 | throw new Error.FAILED("Error from github. \nError code: " + error_code.to_string()); 17 | } 18 | public static void rate_limit_exceeded() throws ValaGist.Error { 19 | throw new Error.FAILED("API rate limit exceeded, error from github."); 20 | } 21 | public static void gist_not_owned(string username, string name) throws ValaGist.Error { 22 | throw new Error.FAILED("Gist \"%s\" not owned by %s.".printf(name, username)); 23 | } 24 | public static void gist_not_on_server(string name) throws ValaGist.Error { 25 | throw new Error.FAILED("Gist \"%s\" not on server".printf(name)); 26 | } 27 | public static void gist_file_not_found_for_delete(string file_name) throws ValaGist.Error { 28 | throw new Error.FAILED("Gist file \"%s\" not found for deletion.".printf(file_name)); 29 | } 30 | public static void gist_needs_more_than_one_file() throws ValaGist.Error { 31 | throw new Error.FAILED("Gist needs more than one file."); 32 | } 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/meson.build: -------------------------------------------------------------------------------- 1 | sources = files( 2 | 'ValaGist.vala', 3 | 'Errors.vala', 4 | 'Gist.vala', 5 | 'GistFile.vala', 6 | 'MyProfile.vala', 7 | 'OtherProfile.vala', 8 | 'Profile.vala' 9 | ) 10 | 11 | valagist_static_lib = static_library('vala-gist', [sources], dependencies: deps, vala_args: []) 12 | valagist_dep = declare_dependency(include_directories: include_directories('.'), link_with: valagist_static_lib) 13 | 14 | # old dynamic lib 15 | # valagist_lib = library('valagist-' + api_version, valagist_sources, 16 | # vala_header: 'valagist-' + api_version + '.h', 17 | # vala_vapi: 'valagist-' + api_version + '.vapi', 18 | # dependencies: [glib, gobject, gio, json_glib, libsoup], 19 | # vala_args: ['--vapidir=' + meson.current_source_dir()], 20 | # c_args: ['-g', '-O0', '-Wno-unused'], 21 | # install: true, 22 | # install_dir: [true, true, true]) 23 | # 24 | # valagist = declare_dependency(include_directories: include_directories('.'), 25 | # link_with: valagist_lib) 26 | # 27 | ## install_headers(meson.current_build_dir() +'/valagist-' + api_version + '.h', subdir: 'valagist-' + api_version) 28 | ## install_data(meson.current_build_dir() + '/valagist-' + api_version + '.vapi', install_dir: 'share/vala/vapi') 29 | # 30 | # pkgconfig = import('pkgconfig') 31 | # pkgconfig.generate(name: 'valagist-' + api_version, 32 | # description: 'Gist client library for Vala', 33 | # version: meson.project_version(), 34 | # filebase: 'valagist-' + api_version, 35 | # requires: 'glib-2.0 gobject-2.0 json-glib-1.0 libsoup-2.4', 36 | # libraries: valagist_lib, 37 | # subdirs: 'valagist-' + api_version) 38 | -------------------------------------------------------------------------------- /src/GistFile.vala: -------------------------------------------------------------------------------- 1 | namespace ValaGist { 2 | 3 | public class GistFile { 4 | public string filename { get; private set; } 5 | internal string temp_filename { get; private set; } 6 | public string g_type { get; private set; } 7 | public string lanuage { get; private set; } 8 | public string file_content { get; private set; } 9 | private string temp_file_content { private get; private set; } 10 | public string raw_url { get; private set; } 11 | public string size { get; private set; } 12 | public bool is_real { get; private set; } 13 | 14 | private Soup.Session session = new Soup.Session(); 15 | private const string BASE_URL = "https://api.github.com"; 16 | 17 | // create a gist file object from parameters 18 | public GistFile(string filename, string file_content, bool is_real=false) { 19 | this.is_real = is_real; 20 | this.filename = filename; 21 | this.temp_filename = this.filename; 22 | this.file_content = file_content; 23 | this.temp_file_content = this.file_content; 24 | } 25 | 26 | // create a gist file object a json 27 | internal GistFile.from_json(Json.Node node, bool is_real=true) { 28 | this.is_real = is_real; 29 | this.filename = node.get_object().get_string_member("filename"); 30 | this.temp_filename = this.filename; // temp_filename is used to store changes to the filename so orginal is unchanged 31 | this.g_type = node.get_object().get_string_member("type"); 32 | this.lanuage = node.get_object().get_string_member("language"); 33 | this.raw_url = node.get_object().get_string_member("raw_url"); 34 | this.size = node.get_object().get_string_member("size"); 35 | } 36 | 37 | // get content of file object 38 | // refresh states if the user wants to get new content from the server 39 | public string get_content(bool refresh = false) { 40 | if(file_content != null && !refresh) return file_content; 41 | var headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 42 | if(MyProfile.token != null){ 43 | headers.append("Authorization", "token %s".printf(MyProfile.token)); 44 | } 45 | 46 | headers.append("User-Agent", "vala-gist"); 47 | Soup.Message msg = new Soup.Message("GET", raw_url); 48 | Soup.MessageBody body = new Soup.MessageBody(); 49 | msg.request_headers = headers; 50 | msg.request_body = body; 51 | session.send_message(msg); 52 | file_content = (string) msg.response_body.data; 53 | temp_file_content = file_content; 54 | return (string) msg.response_body.data; 55 | 56 | } 57 | 58 | // gets to the altered version of the file contents 59 | internal string get_temp_content() { 60 | if(temp_file_content == null){ 61 | return get_content(); 62 | }else{ 63 | return temp_file_content; 64 | } 65 | } 66 | 67 | public void edit_filename(string filename) { 68 | this.temp_filename = filename; 69 | } 70 | 71 | public void edit_file_content(string file_content) { 72 | this.temp_file_content = file_content; 73 | } 74 | 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vala-gist 2 | Gist client library for Vala 3 | 4 | ```vala 5 | using ValaGist; 6 | 7 | public int main (string[] argv) { 8 | var profile = new MyProfile ("ENTER GITHUB TOKEN HERE"); 9 | 10 | Gist[] gists = profile.list_all (); 11 | foreach (Gist gist in gists) { 12 | print (gist.name + "\n"); 13 | print (gist.description + "\n"); 14 | print (gist.created_at + "\n"); 15 | 16 | foreach (GistFile file in gist.files) { 17 | print (file.filename + "\n"); 18 | print (file.get_content()+ "\n"); 19 | } 20 | } 21 | 22 | return 0; 23 | } 24 | ``` 25 | ```sh 26 | valac test.vala --pkg valagist-1.0 27 | ./test 28 | ``` 29 | 30 | ## Dependencies 31 | These dependencies must be present before building 32 | 33 | - `meson>=0.40.1` 34 | - `json-glib-1.0` 35 | - `libsoup-2.4` 36 | 37 | ## Installation 38 | 39 | ```sh 40 | git clone https://github.com/rickybassom/vala-gist.git 41 | meson build 42 | cd build 43 | ninja # or 'ninja-build' on some distributions 44 | ``` 45 | 46 | ## More examples 47 | 48 | ### Create new gist 49 | 50 | ```vala 51 | var profile = new MyProfile ("ENTER GITHUB TOKEN HERE"); 52 | 53 | GistFile[] files = { 54 | new GistFile ("file_name.txt", "file content"), 55 | new GistFile ("file_name2.txt", "file content 2"), 56 | new GistFile ("file_name3.txt", "file content 3") 57 | }; 58 | 59 | profile.create (new Gist ("des", false, files)); 60 | ``` 61 | 62 | ### Edit gist 63 | 64 | ```vala 65 | var profile = new MyProfile ("ENTER GITHUB TOKEN HERE"); 66 | 67 | Gist[] gists = profile.list_all (); 68 | Gist edit_gist = gists[0]; 69 | 70 | edit_gist.edit_description ("Changed description"); 71 | edit_gist.files[0].edit_file_content ("changed content"); 72 | 73 | edit_gist.add_file ( 74 | new GistFile ("newfile.txt", "new file with content!") 75 | ); 76 | 77 | edit_gist.add_file ( 78 | new GistFile ("newfile2.txt", "new file with content! 2") 79 | ); 80 | 81 | profile.edit (edit_gist); 82 | ``` 83 | 84 | ### Delete files 85 | 86 | ```vala 87 | var profile = new MyProfile ("ENTER GITHUB TOKEN HERE"); 88 | 89 | Gist[] gists = profile.list_all (); 90 | Gist edit_gist = gists[0]; 91 | 92 | GistFile[] delete_files = { 93 | edit_gist.files[0], 94 | edit_gist.files[1] 95 | }; 96 | 97 | profile.edit (edit_gist, delete_files); 98 | ``` 99 | 100 | ### Delete gist 101 | 102 | ```vala 103 | var profile = new MyProfile ("ENTER GITHUB TOKEN HERE"); 104 | 105 | Gist[] gists = profile.list_all (); 106 | profile.delete (gists[0]); 107 | ``` 108 | 109 | ### Other profiles 110 | 111 | ```vala 112 | var profile = new MyProfile ("ENTER GITHUB TOKEN HERE"); 113 | 114 | Gist[] gists = profile.list_all (); 115 | Gist gist = gists[0]; 116 | print (gist.owner.name + "\n"); 117 | print (gist.owner.id + "\n"); 118 | print (gist.owner.list_all ()[0].name); 119 | ``` 120 | 121 | ### No login 122 | 123 | ```vala 124 | OtherProfile user = new OtherProfile ("rickybas"); 125 | print (user.name + "\n"); 126 | print (user.id + "\n"); 127 | 128 | Gist[] gists = user.list_all (); 129 | foreach (Gist gist in gists){ 130 | print (gist.name + "\n"); 131 | print (gist.description + "\n"); 132 | print (gist.created_at + "\n"); 133 | 134 | foreach (GistFile file in gist.files) { 135 | print (file.filename + "\n"); 136 | print (file.get_content()+ "\n"); 137 | } 138 | } 139 | ``` 140 | 141 | ## Uninstall 142 | 143 | ```sh 144 | chmod +x uninstall.sh 145 | ./uninstall.sh 146 | ``` 147 | 148 | -------------------------------------------------------------------------------- /src/OtherProfile.vala: -------------------------------------------------------------------------------- 1 | namespace ValaGist { 2 | 3 | public class OtherProfile : Profile, Object { 4 | public string id { get; internal set; } 5 | public string name { get; internal set; } 6 | internal GenericArray internal_gists { get; set; } 7 | 8 | private Soup.Session session = new Soup.Session(); 9 | private Json.Parser parser = new Json.Parser(); 10 | private const string BASE_URL = "https://api.github.com"; 11 | 12 | public OtherProfile(string name, bool check=true) throws ValaGist.Error { 13 | this.internal_gists = new GenericArray(); 14 | if(check){ // if wants to check if token if correct at contructor 15 | if(user_exists(name)){ 16 | this.name = name; 17 | } 18 | }else{ 19 | this.name = name; 20 | } 21 | } 22 | 23 | // create OtherProfile object from json object 24 | internal OtherProfile.from_json(Json.Node node) { 25 | this.internal_gists = new GenericArray(); 26 | this.id = node.get_object().get_object_member("owner").get_int_member("id").to_string(); 27 | this.name = node.get_object().get_object_member("owner").get_string_member("login"); 28 | } 29 | 30 | private bool user_exists(string name) throws ValaGist.Error { 31 | Soup.MessageHeaders headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 32 | if(MyProfile.token != null){ // if actual user loged in 33 | headers.append("Authorization", "token %s".printf(MyProfile.token)); // not essential for requests but increases rate limit 34 | } 35 | headers.append("User-Agent", "vala-gist"); 36 | Soup.Message msg = new Soup.Message("GET", BASE_URL + "/users/%s".printf(name)); 37 | Soup.MessageBody body = new Soup.MessageBody(); 38 | msg.request_headers = headers; 39 | msg.request_body = body; 40 | session.send_message(msg); 41 | 42 | if (msg.status_code != 200) { // if error in response 43 | if (msg.status_code == 401) { // unauthorized 44 | Errors.incorrect_token(msg.status_code); 45 | }else{ 46 | if(msg.response_headers.get_one("X-RateLimit-Remaining") == "0"){ 47 | Errors.rate_limit_exceeded(); 48 | }else{ 49 | Errors.other_network(msg.status_code); 50 | } 51 | } 52 | return false; 53 | }else{ 54 | try{ 55 | parser.load_from_data ((string) msg.response_body.data, -1); 56 | }catch(Error e){ 57 | print(e.message); 58 | } 59 | Json.Object root_object = parser.get_root ().get_object (); 60 | this.id = root_object.get_int_member ("id").to_string(); 61 | this.name = root_object.get_string_member ("login"); 62 | } 63 | return true; 64 | } 65 | 66 | public Gist[] list_all() { 67 | Soup.MessageHeaders headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 68 | if(MyProfile.token != null){ // if actual user loged in 69 | headers.append("Authorization", "token %s".printf(MyProfile.token)); // not essential for requests but increases rate limit 70 | } 71 | headers.append("User-Agent", "vala-gist"); 72 | Soup.Message msg = new Soup.Message("GET", BASE_URL + "/users/%s/gists".printf(this.name)); 73 | Soup.MessageBody body = new Soup.MessageBody(); 74 | msg.request_headers = headers; 75 | msg.request_body = body; 76 | session.send_message(msg); 77 | 78 | this.internal_gists = new GenericArray(); 79 | 80 | if (msg.status_code != 200) { // if error in response 81 | if (msg.status_code == 401) { // unauthorized 82 | Errors.incorrect_token(msg.status_code); 83 | }else{ 84 | if(msg.response_headers.get_one("X-RateLimit-Remaining") == "0"){ 85 | Errors.rate_limit_exceeded(); 86 | }else{ 87 | Errors.other_network(msg.status_code); 88 | } 89 | } 90 | }else{ 91 | try{ 92 | parser.load_from_data ((string) msg.response_body.data, -1); 93 | 94 | Json.Array root_object = parser.get_root().get_array(); 95 | root_object.foreach_element((arr, index, node) => { // for each gist in json 96 | this.internal_gists.add(new Gist.from_json(node)); // append the this.internal_gists field a Gist object from the json of the gist 97 | }); 98 | }catch(Error e){ 99 | print(e.message); 100 | } 101 | } 102 | 103 | return this.internal_gists.data; 104 | } 105 | 106 | } 107 | 108 | } 109 | -------------------------------------------------------------------------------- /src/MyProfile.vala: -------------------------------------------------------------------------------- 1 | namespace ValaGist { 2 | 3 | public class MyProfile : Profile, Object { 4 | public string id { get; internal set; } 5 | public string name { get; internal set; } 6 | internal GenericArray internal_gists { get; set; } 7 | public static string token { get; private set; } 8 | 9 | private Soup.Session session = new Soup.Session(); 10 | private Json.Parser parser = new Json.Parser(); 11 | private const string BASE_URL = "https://api.github.com"; 12 | 13 | public MyProfile(string token, bool check = true) throws ValaGist.Error { 14 | this.internal_gists = new GenericArray(); 15 | if(check){ // if wants to check if token if correct at contructor 16 | if(auth_success(token)){ 17 | MyProfile.token = token; 18 | } 19 | }else{ 20 | MyProfile.token = token; 21 | } 22 | } 23 | 24 | // not sure if useful 25 | public void relogin(string token, bool check=true) throws ValaGist.Error { 26 | if(check){ 27 | if(auth_success(token)){ 28 | MyProfile.token = token; 29 | } 30 | }else{ 31 | MyProfile.token = token; 32 | } 33 | } 34 | 35 | private bool auth_success(string token) throws ValaGist.Error { 36 | Soup.MessageHeaders headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 37 | headers.append("Authorization", "token %s".printf(token)); 38 | headers.append("User-Agent", "vala-gist"); 39 | Soup.Message msg = new Soup.Message("GET", BASE_URL + "/user"); 40 | Soup.MessageBody body = new Soup.MessageBody(); 41 | msg.request_headers = headers; 42 | msg.request_body = body; 43 | session.send_message(msg); 44 | 45 | if (msg.status_code != 200) { // if error in response 46 | if (msg.status_code == 401) { // unauthorized 47 | Errors.incorrect_token(msg.status_code); 48 | }else{ 49 | if(msg.response_headers.get_one("X-RateLimit-Remaining") == "0"){ 50 | Errors.rate_limit_exceeded(); 51 | }else{ 52 | Errors.other_network(msg.status_code); 53 | } 54 | } 55 | return false; 56 | }else{ 57 | try{ 58 | parser.load_from_data ((string) msg.response_body.data, -1); 59 | }catch(Error e){ 60 | print(e.message); 61 | } 62 | Json.Object root_object = parser.get_root ().get_object (); 63 | this.id = root_object.get_int_member ("id").to_string(); 64 | this.name = root_object.get_string_member ("login"); 65 | } 66 | return true; 67 | } 68 | 69 | public Gist[] list_all() { 70 | Soup.MessageHeaders headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 71 | headers.append("Authorization", "token %s".printf(token)); 72 | headers.append("User-Agent", "vala-gist"); 73 | Soup.Message msg = new Soup.Message("GET", BASE_URL + "/gists"); 74 | Soup.MessageBody body = new Soup.MessageBody(); 75 | msg.request_headers = headers; 76 | msg.request_body = body; 77 | session.send_message(msg); 78 | 79 | this.internal_gists = new GenericArray(); 80 | 81 | if (msg.status_code != 200) { // if error in response 82 | if (msg.status_code == 401) { // unauthorized 83 | Errors.incorrect_token(msg.status_code); 84 | }else{ 85 | if(msg.response_headers.get_one("X-RateLimit-Remaining") == "0"){ 86 | Errors.rate_limit_exceeded(); 87 | }else{ 88 | Errors.other_network(msg.status_code); 89 | } 90 | } 91 | }else{ 92 | try{ 93 | parser.load_from_data ((string) msg.response_body.data, -1); 94 | }catch(Error e){ 95 | print(e.message); 96 | } 97 | Json.Array root_object = parser.get_root().get_array(); 98 | root_object.foreach_element((arr, index, node) => { // for each gist in json 99 | this.internal_gists.add(new Gist.from_json(node)); // append the this.internal_gists field a Gist object from the json of the gist 100 | }); 101 | } 102 | 103 | return this.internal_gists.data; 104 | } 105 | 106 | public Gist create(Gist gist) { 107 | Soup.MessageHeaders headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 108 | headers.append("Authorization", "token %s".printf(token)); 109 | headers.append("User-Agent", "vala-gist"); 110 | Soup.Message msg = new Soup.Message("POST", BASE_URL + "/gists"); 111 | Soup.MessageBody body = new Soup.MessageBody(); 112 | 113 | body.append_take(gist.to_json().data); // to_json() converts object to json. add to request body 114 | 115 | msg.request_headers = headers; 116 | msg.request_body = body; 117 | 118 | session.send_message(msg); 119 | 120 | if (msg.status_code != 201) { // if error in response 121 | if (msg.status_code == 401) { // unauthorized 122 | Errors.incorrect_token(msg.status_code); 123 | }else{ 124 | if(msg.response_headers.get_one("X-RateLimit-Remaining") == "0"){ 125 | Errors.rate_limit_exceeded(); 126 | }else{ 127 | Errors.other_network(msg.status_code); 128 | } 129 | } 130 | } 131 | 132 | Json.Node root = new Json.Node(Json.NodeType.OBJECT); 133 | try{ 134 | parser.load_from_data((string) msg.response_body.flatten().data, -1); 135 | root.set_object(parser.get_root().get_object()); 136 | } catch(Error e){ 137 | print(e.message); 138 | } 139 | 140 | list_all(); 141 | return new Gist.from_json(root); // return gist created on server 142 | } 143 | 144 | public Gist edit(Gist gist, GLib.Array delete_files = new GLib.Array ()) { 145 | GenericArray _delete_files = new GenericArray(); 146 | _delete_files.data = delete_files.data; 147 | 148 | if(gist.id == null){ // gist not on server 149 | Errors.gist_not_on_server(gist.name); 150 | } else if(gist.owner.id != this.id){ // if the gist has not been created by this user 151 | Errors.gist_not_owned(this.name, gist.name); 152 | } 153 | 154 | Soup.MessageHeaders headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 155 | headers.append("Authorization", "token %s".printf(token)); 156 | headers.append("User-Agent", "vala-gist"); 157 | Soup.Message msg = new Soup.Message("PATCH", BASE_URL + "/gists/" + gist.id); 158 | Soup.MessageBody body = new Soup.MessageBody(); 159 | 160 | if(_delete_files.length == 0){ 161 | body.append_take(gist.to_json(true).data); 162 | }else{ 163 | body.append_take(gist.to_json(true, _delete_files.data).data); 164 | } 165 | 166 | msg.request_headers = headers; 167 | msg.request_body = body; 168 | 169 | session.send_message(msg); 170 | 171 | if (msg.status_code != 200) { // if error in response 172 | if (msg.status_code == 401) { // unauthorized 173 | Errors.incorrect_token(msg.status_code); 174 | }else{ 175 | if(msg.response_headers.get_one("X-RateLimit-Remaining") == "0"){ 176 | Errors.rate_limit_exceeded(); 177 | }else{ 178 | Errors.other_network(msg.status_code); 179 | } 180 | } 181 | } 182 | 183 | Json.Node root = new Json.Node(Json.NodeType.OBJECT); 184 | try{ 185 | parser.load_from_data((string) msg.response_body.flatten().data, -1); 186 | root.set_object(parser.get_root().get_object()); 187 | }catch(Error e){ 188 | print(e.message); 189 | } 190 | list_all(); 191 | return new Gist.from_json(root); // return edited gist from server 192 | } 193 | 194 | public void delete(Gist gist) { 195 | if(gist.id == null){ // gist not on server 196 | Errors.gist_not_on_server(gist.name); 197 | } 198 | else if(gist.owner.id != this.id){ // if the gist has not been created by this user 199 | Errors.gist_not_owned(this.name, gist.name); 200 | } 201 | 202 | Soup.MessageHeaders headers = new Soup.MessageHeaders(Soup.MessageHeadersType.REQUEST); 203 | headers.append("Authorization", "token %s".printf(token)); 204 | headers.append("User-Agent", "vala-gist"); 205 | Soup.Message msg = new Soup.Message("DELETE", BASE_URL + "/gists/" + gist.id); 206 | 207 | 208 | msg.request_headers = headers; 209 | 210 | session.send_message(msg); 211 | 212 | if (msg.status_code != 204) { // if error in response 213 | if (msg.status_code == 401) { // unauthorized 214 | Errors.incorrect_token(msg.status_code); 215 | }else{ 216 | if(msg.response_headers.get_one("X-RateLimit-Remaining") == "0"){ 217 | Errors.rate_limit_exceeded(); 218 | }else{ 219 | Errors.other_network(msg.status_code); 220 | } 221 | } 222 | } 223 | 224 | list_all(); 225 | } 226 | 227 | } 228 | 229 | } 230 | -------------------------------------------------------------------------------- /src/Gist.vala: -------------------------------------------------------------------------------- 1 | namespace ValaGist { 2 | 3 | public class Gist { 4 | public string id { get; private set; } 5 | public string name { get; private set; } 6 | public string url { get; private set; } 7 | public string description { get; private set; } 8 | private string temp_description { private get; private set; } 9 | public bool is_public { get; private set; } 10 | internal GenericArray internal_files { get; set; } 11 | public GistFile[] files { 12 | get { return this.internal_files.data; } 13 | private set {} 14 | } 15 | private GenericArray temp_files { private get; private set; } 16 | public string created_at { get; private set; } 17 | public string updated_at { get; private set; } 18 | public OtherProfile owner { get; private set; } 19 | 20 | // create a gist object from parameters 21 | public Gist(string description, bool is_public, 22 | GistFile[] files) { 23 | internal_files = new GenericArray(); 24 | this.internal_files.data = files; 25 | 26 | this.description = description; 27 | this.temp_description = this.description; 28 | this.is_public = is_public; 29 | if(internal_files.length == 0){ 30 | Errors.gist_needs_more_than_one_file(); 31 | } 32 | this.internal_files.sort((a, b) => { // sort by filename 33 | CompareFunc strcmp = GLib.strcmp; 34 | return strcmp(a.filename, b.filename); 35 | }); 36 | this.temp_files = this.internal_files; // temp_files is used to store changes to the files so orginal is unchanged 37 | this.name = this.internal_files[0].filename; // first file's name in gist is the name of the whole gist 38 | } 39 | 40 | // create a gist object a json gist file 41 | internal Gist.from_json(Json.Node node) { 42 | this.internal_files = new GenericArray(); // array used to store files of gist 43 | 44 | // set object fields to node properties 45 | this.id = node.get_object().get_string_member("id"); 46 | this.url = node.get_object().get_string_member("html_url"); 47 | this.description = node.get_object().get_string_member("description"); 48 | this.temp_description = this.description; 49 | this.is_public = node.get_object().get_boolean_member("public"); 50 | node.get_object().get_object_member("files").foreach_member((arr, index, node) => { // loop through array files in json and append GistFile object to array 51 | this.internal_files.add(new GistFile.from_json(node)); // constructor in GistFile.from_json extracts data from node into object fields 52 | }); 53 | this.temp_files = this.internal_files; // temp_files is used to store changes to the files so orginal is unchanged 54 | this.name = this.internal_files[0].filename; // first file's name in gist is the name of the whole gist 55 | this.created_at = node.get_object().get_string_member("created_at"); 56 | this.updated_at = node.get_object().get_string_member("updated_at"); 57 | this.owner = new OtherProfile.from_json(node); 58 | } 59 | 60 | // converts object to json 61 | public string to_json(bool use_temp = false, GistFile[] delete_files = {}) { 62 | // See below for example gist in json format 63 | var generator = new Json.Generator (); 64 | 65 | var builder = new Json.Builder (); 66 | builder.begin_object (); // { 67 | 68 | builder.set_member_name ("description") 69 | .add_string_value (use_temp ? temp_description : description); // "description": "description of gist", 70 | 71 | builder.set_member_name ("public") 72 | .add_boolean_value (is_public); // "public": true, 73 | 74 | var files_json = builder.set_member_name ("files"); 75 | files_json.begin_object (); // "files": { 76 | (use_temp ? temp_files : this.internal_files).foreach((file) => { 77 | // get files to delete from changed filenames 78 | if (file.temp_filename != file.filename && file.is_real) { 79 | files_json.set_member_name (file.filename) 80 | .add_null_value (); // "this is a filename": null 81 | } 82 | 83 | files_json.set_member_name ((use_temp && !file.is_real) ? file.temp_filename : file.filename); 84 | files_json.begin_object (); // "this is a filename": { 85 | files_json.set_member_name ("filename"); 86 | files_json.add_string_value (use_temp ? file.temp_filename : file.filename); // "filename": "this is a filename", 87 | files_json.set_member_name ("content"); 88 | files_json.add_string_value (use_temp ? file.get_temp_content() : file.get_content()); // "content": "contents of gist" 89 | files_json.end_object (); // } 90 | }); 91 | if (delete_files.length != 0) { 92 | foreach (GistFile delete_file in delete_files) { 93 | files_json.set_member_name (delete_file.filename) 94 | .add_null_value (); // "this is a filename": null 95 | } 96 | } 97 | files_json.end_object (); // } 98 | 99 | builder.end_object (); // } 100 | 101 | generator.set_root (builder.get_root ()); 102 | return generator.to_data (null); 103 | } 104 | 105 | // checks if filename is in the gists files 106 | internal bool includes_file(string filename) { 107 | bool found = false; 108 | this.internal_files.foreach((file) => { 109 | if(file.filename == filename){ 110 | found = true; 111 | return; 112 | } 113 | }); 114 | return found; 115 | } 116 | 117 | public void edit_description(string description) { 118 | this.temp_description = description; // changes non-orginal copy of description 119 | } 120 | 121 | public void add_file(GistFile file) { 122 | this.temp_files.add (file); // changes non-orginal copy of files 123 | } 124 | 125 | public void replace_with_files (GistFile[] files) { 126 | this.temp_files.data = files; 127 | } 128 | } 129 | 130 | } 131 | 132 | 133 | /* 134 | Example gist 135 | { 136 | "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", 137 | "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", 138 | "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", 139 | "id": "aa5a315d61ae9438b18d", 140 | "description": "description of gist", 141 | "public": true, 142 | "owner": { 143 | "login": "octocat", 144 | "id": 1, 145 | "avatar_url": "https://github.com/images/error/octocat_happy.gif", 146 | "gravatar_id": "", 147 | "url": "https://api.github.com/users/octocat", 148 | "html_url": "https://github.com/octocat", 149 | "followers_url": "https://api.github.com/users/octocat/followers", 150 | "following_url": "https://api.github.com/users/octocat/following{/other_user}", 151 | "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", 152 | "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", 153 | "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", 154 | "organizations_url": "https://api.github.com/users/octocat/orgs", 155 | "repos_url": "https://api.github.com/users/octocat/repos", 156 | "events_url": "https://api.github.com/users/octocat/events{/privacy}", 157 | "received_events_url": "https://api.github.com/users/octocat/received_events", 158 | "type": "User", 159 | "site_admin": false 160 | }, 161 | "user": null, 162 | "files": { 163 | "this is a filename": { 164 | "filename": "this is a filename", 165 | "size": 932, 166 | "raw_url": "https://gist.githubusercontent.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl", 167 | "type": "text/plain", 168 | "language": "Erlang", 169 | "truncated": false, 170 | "content": "contents of gist" 171 | } 172 | }, 173 | "truncated": false, 174 | "comments": 0, 175 | "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", 176 | "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", 177 | "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", 178 | "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", 179 | "created_at": "2010-04-14T02:15:15Z", 180 | "updated_at": "2011-06-20T11:34:15Z", 181 | "forks": [ 182 | { 183 | "user": { 184 | "login": "octocat", 185 | "id": 1, 186 | "avatar_url": "https://github.com/images/error/octocat_happy.gif", 187 | "gravatar_id": "", 188 | "url": "https://api.github.com/users/octocat", 189 | "html_url": "https://github.com/octocat", 190 | "followers_url": "https://api.github.com/users/octocat/followers", 191 | "following_url": "https://api.github.com/users/octocat/following{/other_user}", 192 | "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", 193 | "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", 194 | "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", 195 | "organizations_url": "https://api.github.com/users/octocat/orgs", 196 | "repos_url": "https://api.github.com/users/octocat/repos", 197 | "events_url": "https://api.github.com/users/octocat/events{/privacy}", 198 | "received_events_url": "https://api.github.com/users/octocat/received_events", 199 | "type": "User", 200 | "site_admin": false 201 | }, 202 | "url": "https://api.github.com/gists/dee9c42e4998ce2ea439", 203 | "id": "dee9c42e4998ce2ea439", 204 | "created_at": "2011-04-14T16:00:49Z", 205 | "updated_at": "2011-04-14T16:00:49Z" 206 | } 207 | ], 208 | "history": [ 209 | { 210 | "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", 211 | "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", 212 | "user": { 213 | "login": "octocat", 214 | "id": 1, 215 | "avatar_url": "https://github.com/images/error/octocat_happy.gif", 216 | "gravatar_id": "", 217 | "url": "https://api.github.com/users/octocat", 218 | "html_url": "https://github.com/octocat", 219 | "followers_url": "https://api.github.com/users/octocat/followers", 220 | "following_url": "https://api.github.com/users/octocat/following{/other_user}", 221 | "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", 222 | "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", 223 | "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", 224 | "organizations_url": "https://api.github.com/users/octocat/orgs", 225 | "repos_url": "https://api.github.com/users/octocat/repos", 226 | "events_url": "https://api.github.com/users/octocat/events{/privacy}", 227 | "received_events_url": "https://api.github.com/users/octocat/received_events", 228 | "type": "User", 229 | "site_admin": false 230 | }, 231 | "change_status": { 232 | "deletions": 0, 233 | "additions": 180, 234 | "total": 180 235 | }, 236 | "committed_at": "2010-04-14T02:15:15Z" 237 | } 238 | ] 239 | } 240 | */ 241 | 242 | -------------------------------------------------------------------------------- /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 | {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 | --------------------------------------------------------------------------------