├── .gitignore ├── .gitmodules ├── config_sample.json ├── prune_times.pl ├── README.md ├── toggl_admin.py ├── get_weekly_toggl.py ├── log_in_redmine.pl └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | json/ 2 | config.json 3 | accumulated_time.txt 4 | *.bk 5 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "rmclient.git"] 2 | path = rmclient.git 3 | url = git@github.com:NBISweden/rmclient.git 4 | branch = feature/get-specific-issue 5 | -------------------------------------------------------------------------------- /config_sample.json: -------------------------------------------------------------------------------- 1 | { 2 | "entry_map": { 3 | "task": "client", 4 | "activity": "project", 5 | "comment": "description" 6 | }, 7 | "issue_map": { 8 | "Project1": 2, 9 | "Project2": 9 10 | }, 11 | "secrets": { 12 | "redmine": "my-redmine-token", 13 | "toggl": "my-toggle-token" 14 | }, 15 | "prune_times": { 16 | "accumulated_time": "accumulated_time.txt", 17 | "paskanakki": "Infrastructure:NBIS General:Admin:" 18 | } 19 | -------------------------------------------------------------------------------- /prune_times.pl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env perl 2 | use strict; 3 | use warnings; 4 | 5 | use POSIX qw(floor ceil); 6 | 7 | use feature qw( :5.18 ); 8 | 9 | use DateTime; 10 | 11 | use JSON qw( from_json to_json ); 12 | 13 | my $config = load_config(); 14 | 15 | my $accumulated_time_file = $config->{prune_times}{accumulated_time_file}; 16 | my $paskanakki = $config->{prune_times}{paskanakki}; # https://translate.google.se/?source=osdd#auto/en/paskanakki 17 | 18 | my $file = shift // die "Need input file\n"; 19 | 20 | my $outfile = $file =~ s/(.+)\.(.+)/$1_pruned.$2/r; 21 | open my $OF, '>', $outfile or die; 22 | 23 | my $json = from_json(slurp($file)); 24 | 25 | if ( ref($json) ne "ARRAY" ) { 26 | $json = [ $json ]; 27 | } 28 | 29 | my $at = 0; 30 | if ( -f $accumulated_time_file ) { 31 | $at = slurp($accumulated_time_file); 32 | chomp($at); 33 | } 34 | printf STDERR "Accumulated time: %4.1f\n", $at; 35 | # my $roundoff_tally = 0; 36 | my $roundoff_tally = $at; 37 | 38 | my $rounded_sum = 0; 39 | 40 | for my $week (@$json) { 41 | while (my ($key, $entry) = each %{$week->{'work'}} ) { 42 | my $dur = $entry->{'duration'}; 43 | my $tail = $dur - int( $dur ); 44 | 45 | my $rounded; 46 | if ($tail < 0.33) { 47 | $rounded = floor($dur); 48 | $roundoff_tally += $tail; 49 | } elsif ($tail < 0.5) { 50 | $rounded = floor($dur) + 0.5; 51 | $roundoff_tally -= 0.5 - $tail; 52 | } elsif ($tail < 0.83) { 53 | $rounded = floor($dur) + 0.5; 54 | $roundoff_tally += $tail - 0.5; 55 | } else { 56 | $rounded = ceil($dur); 57 | $roundoff_tally -= 1.0 - $tail; 58 | } 59 | 60 | $entry->{'duration'} = $rounded; 61 | delete $week->{'work'}{$key} if $rounded == 0; 62 | 63 | $rounded_sum += $rounded; 64 | 65 | printf STDERR "%-3s %40s: %6.2f; rounded: %6.2f; tally: %6.2f\n", 66 | ($rounded == 0 ? 'DEL' : ''), $key, $dur, $rounded, $roundoff_tally; 67 | } 68 | 69 | # Number of halfhours left, will be negative if we overcommit 70 | my $half_hours_left = floor( abs($roundoff_tally / 0.5 ) ) * ($roundoff_tally > 0 ? 1 : -1); 71 | my $addition = $half_hours_left * 0.5; 72 | 73 | $week->{work}{$paskanakki}{duration} += $addition; 74 | 75 | # Don't log negative times, move to next week. 76 | if ( $week->{work}{$paskanakki}{duration} < 0 ) { 77 | $addition -= $week->{work}{$paskanakki}{duration}; 78 | $week->{work}{$paskanakki}{duration} = 0; 79 | } 80 | $rounded_sum += $addition; 81 | $roundoff_tally -= $addition; 82 | 83 | printf STDERR "Added %3.1f to %s\n", $addition, $paskanakki; 84 | 85 | $week->{'rounded_sum'} = $rounded_sum; 86 | } 87 | 88 | print $OF to_json(@$json[0], {utf8 => 1, pretty => 1}) . "\n"; 89 | close $OF; 90 | 91 | open my $AT, '>', $accumulated_time_file; 92 | print $AT $roundoff_tally; 93 | close $AT; 94 | 95 | sub slurp { 96 | my $file = shift; 97 | open my $F, '<', $file or die "Couldn't open $file\n"; 98 | local $/ = ''; 99 | my $data = <$F>; 100 | return $data; 101 | } 102 | 103 | sub load_config { 104 | my $json = from_json(slurp('config.json')); 105 | return $json; 106 | } 107 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sync toggl timings into NBIS redmine system 2 | 3 | ## Prerequisites 4 | 5 | ### Python 2.7 6 | 7 | Just the core modules. 8 | 9 | ### Ruby 10 | 11 | ```bash 12 | gem install rmclient 13 | ``` 14 | 15 | ### Perl 16 | 17 | The following modules need to be installed, for example with `cpan`. 18 | 19 | DateTime 20 | JSON 21 | 22 | ```bash 23 | cpan DateTime JSON 24 | ``` 25 | 26 | ## Initialize the code 27 | 28 | ```bash 29 | git clone git@github.com:viklund/time-tracker.git 30 | cd time-tracker 31 | ``` 32 | 33 | ## Configure the json file 34 | 35 | Copy the `config_sample.json` file into `config.json` and update according to 36 | below. 37 | 38 | ### API keys 39 | 40 | Find the API keys in your redmine and toggl account and add them to the 41 | `config.json` file. 42 | 43 | ### Use toggl in a way that is compatible with the redmine system 44 | 45 | In toggl there are 4 different fields for each running task: 46 | 47 | - Client 48 | - Project 49 | - Task comment/description 50 | - Tags 51 | 52 | In redmine we have 3 different things that we want to log: 53 | 54 | - Issue number (task) 55 | - Activity (Admin, Support, OwnTraining and so forth) 56 | - Comment 57 | 58 | For the automation to work toggl needs to be used in a consistent manner and 59 | the script needs to know how to map each of the different types of toggl fields 60 | into redmine. For this you use the `entry_map` and `issue_map` fields in the 61 | `config.json`. 62 | 63 | #### Entry map 64 | 65 | The entry map is used to map the 4 different toggl fields into the redmine 66 | fields. The keys should be the redmine fields and the values are the names of 67 | the toggl fields. 68 | 69 | I use the client field to identify issue number, project to identify type of 70 | activity and the comment field to specify a short comment on what I'm doing 71 | ("testing patch", "Updating the time-tracker README", "Email" and so forth). 72 | So in my case the entry map looks like this: 73 | 74 | ```json 75 | "entry_map": { 76 | "task": "client", 77 | "activity": "project", 78 | "comment": "description" 79 | }, 80 | ``` 81 | 82 | #### Issue map 83 | 84 | To map the different tasks into redmine issues, this mapping needs to be 85 | specified. So you have to come up with names for all the issues you are 86 | working on and then specify to what issue this should be mapped in the redmine 87 | system. I for example have the client as the issue mapping so when I'm working 88 | on issue number 3534 which is the LocalEGA project I instead write LocalEGA in 89 | the client field in toggle and then have this line in the `issue_map`: 90 | 91 | ```json 92 | "issue_map": { 93 | "LocalEGA": 3534 94 | } 95 | ``` 96 | 97 | #### What about activity 98 | 99 | To specify whether I am doing _administration_ or _development_ I just write 100 | that in the project field in the toggl (but you can have it somewhere else if 101 | you change the `entry_map`). These mappings are hardcoded in the perl script, 102 | the available categories are: 103 | 104 | Design 105 | Development 106 | Own Training 107 | Teaching 108 | Presenting 109 | Support 110 | Implementation 111 | Administration 112 | Admin 113 | Absence 114 | Core Facility Support 115 | 116 | ## Running the scripts 117 | 118 | ### Fetch information from toggl 119 | 120 | The `get_weekly_toggls.py` has two command line options options, `--start` and 121 | `--end` which are used to specify how far back you want to go. 122 | 123 | Both are either a date or the number of weeks to go back. If sepcified as a 124 | date, the script will take the week that has that date in it as starting or end 125 | point (the script never works with partial weeks). 126 | 127 | This will fetch the last weeks work: 128 | 129 | ```bash 130 | $ ./get_weekly_toggl.py --start 1 --end 1 131 | ``` 132 | 133 | This will fetch the last 3 weeks work: 134 | 135 | ```bash 136 | $ ./get_weekly_toggl.py --start 3 --end 1 137 | ``` 138 | 139 | This will fetch four weeks of work, the weeks with fridays on: 140 | - 2017-10-20 141 | - 2017-10-27 142 | - 2017-11-03 143 | 144 | ```bash 145 | $ ./get_weekly_toggl.py --start 2017-10-18 --end 2017-11-01 146 | ``` 147 | 148 | ### Quality control of the files 149 | 150 | Check the `.json` files in the `json` subdirectory so that everything looks 151 | ok. 152 | 153 | ### Sync everything into redmine 154 | 155 | First make a test sync to make sure that you have everything setup correctly: 156 | 157 | ```bash 158 | $ ./log_in_redmine.pl json/info_2017-10-06.json 159 | ``` 160 | 161 | This will warn about unkown issue mappings which you should add to the 162 | `config.json` 163 | 164 | When that seems to work ok, you can run the script with `--insert`: 165 | 166 | 167 | ```bash 168 | $ ./log_in_redmine.pl --insert json/info_2017-10-06.json 169 | ``` 170 | 171 | 172 | # TODO 173 | 174 | * Make a docker container of everything for ease of use 175 | -------------------------------------------------------------------------------- /toggl_admin.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import json 3 | import requests 4 | import urllib.parse 5 | import base64 6 | import sys 7 | import datetime 8 | from os.path import isfile 9 | 10 | toggl_username = json.load(open('config.json'))['secrets']['toggl'] 11 | 12 | class TZ(datetime.tzinfo): 13 | def utcoffset(self, dt): return datetime.timedelta(hours=0) 14 | def dst(self,dt): return datetime.timedelta(hours=0) 15 | 16 | def get_response(url, method="GET", params=None, data=None, headers={'content-type' : 'application/json'}): 17 | password="api_token" 18 | auth = requests.auth.HTTPBasicAuth(toggl_username, password) 19 | 20 | try: 21 | if method == "GET": 22 | r = requests.get(url, auth=auth, params=params, data=data, headers=headers) 23 | elif method == "POST": 24 | r = requests.post(url, auth=auth, params=params, data=data, headers=headers) 25 | elif method == "PUT": 26 | r = requests.put(url, auth=auth, params=params, data=json.dumps(data), headers=headers) 27 | else: 28 | raise NotImplementedError('HTTP method "{}" not implemented.'.format(method)) 29 | r.raise_for_status() 30 | except Exception as e: 31 | print("OOps, something went wrong") 32 | print(e) 33 | sys.exit(1) 34 | 35 | return r.json() 36 | 37 | client_infos = {} 38 | def get_client_info(cid): 39 | if cid not in client_infos: 40 | url = "https://www.toggl.com/api/v8/clients/%s" % cid 41 | data = get_response(url) 42 | client_infos[cid] = data['data'] 43 | 44 | return client_infos[cid] 45 | 46 | project_infos = {} 47 | def get_project_info(pid): 48 | if pid not in project_infos: 49 | url = "https://www.toggl.com/api/v8/projects/%s" % pid 50 | data = get_response(url) 51 | data = data['data'] 52 | if 'cid' in data: 53 | client = get_client_info(data['cid']) 54 | data['client'] = client 55 | else: 56 | data['client'] = '' 57 | project_infos[pid] = data 58 | 59 | return project_infos[pid] 60 | 61 | def check_week_of(day): 62 | monday = day - datetime.timedelta( 63 | days=day.weekday(), 64 | microseconds=day.microsecond, 65 | hours=day.hour) 66 | friday = monday + datetime.timedelta(days = 6) 67 | 68 | url = "https://www.toggl.com/api/v8/time_entries" 69 | params = { 70 | "start_date": monday.isoformat(), 71 | "end_date": friday.isoformat(), 72 | } 73 | 74 | data = get_response(url, params=params) 75 | return data 76 | 77 | def get_stuff(): 78 | return get_response("https://www.toggl.com/api/v8/me?with_related_data=true") 79 | 80 | def dump(data): 81 | print((json.dumps(data, sort_keys=True, indent=4, 82 | separators=(',',': ')))) 83 | 84 | def dump_file(data, file): 85 | with open(file, 'w') as out: 86 | json.dump(data, out, sort_keys=True, indent=4, separators=(',',': ')) 87 | 88 | def load_file(file): 89 | with open(file, 'r') as f: 90 | return json.load(f) 91 | 92 | def friday_of(dt): 93 | return dt + datetime.timedelta(days=(4 - dt.weekday())) 94 | 95 | def fix_admin(): 96 | now = datetime.datetime.now(TZ()) 97 | for delta in range(8,52): 98 | check_time = now - datetime.timedelta(days=7*delta) 99 | print("Checking {} {}".format(delta, check_time.strftime("%Y-%m-%d"))) 100 | 101 | data = check_week_of(check_time) 102 | 103 | for d in data: 104 | if not 'pid' in d: 105 | print("Can't find pid for {}".format(d['id'])) 106 | dump(d) 107 | continue 108 | proj_info = get_project_info( d['pid'] ) 109 | 110 | cname = "" 111 | cid = "" 112 | if 'cid' in proj_info: 113 | cname = proj_info['client']['name'] 114 | cid = proj_info['client']['id'] 115 | 116 | print(" {:8} {:20.20} {:>15.15}:{} {:>15.15}:{}".format( 117 | d['id'], d['description'], 118 | proj_info['name'], proj_info['id'], 119 | cname, cid )) 120 | 121 | # PID:31466296 122 | desc = d['description'] 123 | if not 'cid' in proj_info and ( desc == 'Admin' or desc == 'Email'): 124 | data = { "time_entry": { "pid":31466296 }} 125 | url="https://www.toggl.com/api/v8/time_entries/{}".format(d["id"]) 126 | r = get_response(url, method="PUT", data=data) 127 | 128 | if __name__ == '__main__': 129 | data = get_stuff() 130 | data = data['data'] 131 | 132 | projects = data['projects'] 133 | clients = data['clients'] 134 | 135 | print("Projects without client") 136 | plookup = {} 137 | for p in projects: 138 | if 'cid' in p: 139 | cid = p['cid'] 140 | if cid not in plookup: 141 | plookup[cid] = [] 142 | plookup[cid].append(p) 143 | elif p['active']: 144 | print(" {} ({})".format(p['name'], p['id'])) 145 | else: 146 | print(" ({})".format(p['name'])) 147 | 148 | print("\n\n---\n") 149 | 150 | for c in clients: 151 | print("{} {}".format(c['name'],c['id'])) 152 | cid = c['id'] 153 | if cid in plookup: 154 | for p in plookup[cid]: 155 | print(" {}".format(p['name'])) 156 | 157 | -------------------------------------------------------------------------------- /get_weekly_toggl.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | import json 3 | import urllib2 4 | import base64 5 | import sys 6 | import datetime 7 | from os.path import isfile 8 | import os 9 | import argparse 10 | 11 | toggl_username = json.load(open('config.json'))['secrets']['toggl'] 12 | 13 | class TZ(datetime.tzinfo): 14 | def utcoffset(self, dt): return datetime.timedelta(hours=0) 15 | def dst(self,dt): return datetime.timedelta(hours=0) 16 | 17 | def get_response(url): 18 | password="api_token" 19 | auth_header = "Basic %s" % (base64.b64encode('%s:%s' % (toggl_username,password))) 20 | 21 | request = urllib2.Request( url ) 22 | request.add_header("Authorization", auth_header) 23 | 24 | try: 25 | res = urllib2.urlopen(request) 26 | data = json.load(res) 27 | except IOError as e: 28 | print("OOps, something went wrong") 29 | print(e) 30 | sys.exit(1) 31 | 32 | return data 33 | 34 | client_infos = {} 35 | def get_client_info(cid): 36 | if not client_infos.has_key(cid): 37 | url = "https://www.toggl.com/api/v8/clients/%s" % cid 38 | data = get_response(url) 39 | client_infos[cid] = data['data'] 40 | 41 | return client_infos[cid] 42 | 43 | 44 | project_infos = {} 45 | def get_project_info(pid): 46 | if not project_infos.has_key(pid): 47 | url = "https://www.toggl.com/api/v8/projects/%s" % pid 48 | data = get_response(url) 49 | data = data['data'] 50 | if data.has_key('cid'): 51 | client = get_client_info(data['cid']) 52 | data['client'] = client['name'] 53 | else: 54 | data['client'] = '' 55 | project_infos[pid] = data 56 | 57 | return project_infos[pid] 58 | 59 | 60 | def check_week_of(day): 61 | saturday = day - datetime.timedelta( 62 | days=day.weekday() + 2, # Saturday 63 | minutes=day.minute, 64 | seconds=day.second, 65 | hours=day.hour) # saturday 00:00:00 66 | friday = saturday + datetime.timedelta( 67 | days = 7) # changed to 7 to set the end date to midnight Saturday 68 | url = "https://www.toggl.com/api/v8/time_entries?start_date=%s&end_date=%s" % ( 69 | urllib2.quote(saturday.isoformat()), 70 | urllib2.quote(friday.isoformat())) 71 | 72 | data = get_response(url) 73 | 74 | ## sums["client:projname:entry descr:tag"] = total time 75 | entries = {} 76 | for entry in data: 77 | myentry = { 78 | 'client': 'None', 79 | 'project': 'None', 80 | 'description': '', 81 | 'tag': '', 82 | 'duration': 0, 83 | } 84 | if entry['duration'] == 0: 85 | continue 86 | if entry.has_key('tags'): 87 | myentry['tag'] = ' / '.join(entry['tags']) 88 | if entry.has_key('pid'): 89 | project = get_project_info(entry['pid']) 90 | myentry['project'] = project['name'] 91 | myentry['client'] = project['client'] 92 | myentry['description'] = entry.get('description','') 93 | if entry['duration'] > 0: 94 | myentry['duration'] = entry['duration']/3600.0 95 | hash = ':'.join( [ myentry[k] for k in ['client', 'project', 'description', 'tag'] ] ) 96 | 97 | if entries.has_key(hash): 98 | entries[hash]['duration'] += myentry['duration'] 99 | else: 100 | entries[hash] = myentry 101 | 102 | 103 | return entries 104 | 105 | def dump(data): 106 | print(json.dumps(data, sort_keys=True, indent=4, 107 | separators=(',',': '))) 108 | 109 | def dump_file(data, file): 110 | with open(file, 'w') as out: 111 | json.dump(data, out, sort_keys=True, indent=4, separators=(',',': ')) 112 | 113 | def friday_of(dt): 114 | return dt + datetime.timedelta(days=(4 - dt.weekday())) 115 | 116 | def sunday_of(dt): 117 | return dt + datetime.timedelta(days=(6 - dt.weekday())) 118 | 119 | def get_delta(timepoint): 120 | tests = [ lambda x: int(timepoint), 121 | lambda x: (sunday_of(datetime.datetime.now()) - datetime.datetime.strptime(timepoint, "%Y-%m-%d")).days / 7 ] 122 | for t in tests: 123 | try: 124 | result = t(args) 125 | return result 126 | except ValueError: 127 | pass 128 | 129 | raise Exception("Value should be either a date or a number of weeks") 130 | 131 | 132 | if __name__ == '__main__': 133 | parser = argparse.ArgumentParser(description='Retrieve data from toggl') 134 | parser.add_argument('--start', type=str, help='Start point to sync from, either number of weeks back or a date', default=1) 135 | parser.add_argument('--end', type=str, help='End point of sync interval', default=1) 136 | 137 | args = parser.parse_args() 138 | 139 | try: 140 | os.stat('json') 141 | except: 142 | os.mkdir('json') 143 | 144 | start = get_delta(args.start) 145 | end = get_delta(args.end) 146 | 147 | now = datetime.datetime.now(TZ()) 148 | 149 | for delta in range(end, start+1): 150 | check_time = now - datetime.timedelta(days=7*delta) 151 | friday = friday_of(check_time).strftime("%Y-%m-%d") 152 | 153 | outfile = 'json/info_{}.json'.format(friday) 154 | 155 | if isfile(outfile): 156 | print("We already have checked {}, skipping".format(friday)) 157 | continue 158 | 159 | print("Processing {}".format(friday)) 160 | 161 | hours = check_week_of(check_time) 162 | sum = 0 163 | for entry in hours.values(): 164 | sum += entry['duration'] 165 | info = { 166 | "week": friday, 167 | "sum": sum, 168 | "work": hours, 169 | } 170 | dump_file(info, outfile) 171 | -------------------------------------------------------------------------------- /log_in_redmine.pl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env perl 2 | use strict; 3 | use warnings; 4 | 5 | use feature qw( :5.18 ); 6 | 7 | use Getopt::Long; 8 | use DateTime; 9 | 10 | use JSON qw( from_json to_json ); 11 | 12 | 13 | my $insert = ''; 14 | my $check = ''; 15 | GetOptions( 16 | 'insert' => \$insert, 17 | 'check' => \$check, 18 | ) or die "Could not parse options\n"; 19 | 20 | my $file = shift // die "Need input file\n"; 21 | my $json = from_json(slurp($file)); 22 | 23 | if ( ref($json) ne "ARRAY" ) { 24 | $json = [ $json ]; 25 | } 26 | 27 | my $config = load_config(); 28 | 29 | my $apikey = $config->{'secrets'}{'redmine'}; 30 | my $redmine_url = 'https://projects.nbis.se'; 31 | my $rmclient = 'rmclient'; 32 | 33 | my %issue_of = %{ $config->{issue_map} }; 34 | our %entry_mapping = %{ $config->{entry_map} }; 35 | 36 | my %activity_id_of = ( 37 | Design => 8, 38 | Development => 9, 39 | "Own Training" => 10, 40 | Teaching => 11, 41 | Presenting => 12, 42 | Support => 13, 43 | Implementation => 14, 44 | Administration => 18, 45 | Admin => 18, 46 | Absence => 19, 47 | "Core Facility Support" => 20, 48 | "Consultation" => 33, 49 | ); 50 | 51 | my %activity_of_id = map { ($activity_id_of{$_}, $_) } keys %activity_id_of; 52 | 53 | my @ok_entries; 54 | my $error = ''; 55 | 56 | my $tot_time = 0; 57 | 58 | for my $week (@$json) { 59 | my $dt = $week->{'week'}; 60 | for my $entry ( values %{ $week->{'work'} } ) { 61 | my $issue = get_issue_of( $entry ); 62 | if ( ! $issue ) { 63 | $error = 1; 64 | next; 65 | } 66 | 67 | my $comment = $entry->{ $entry_mapping{comment} }; 68 | if ($comment eq 'None') { $comment = ''; } 69 | 70 | my $activity_id = $activity_id_of{ $entry->{ $entry_mapping{activity} } }; 71 | 72 | my $issue_title = issue_lookup($issue); 73 | if ( ! $issue_title ) { 74 | say STDERR "WARNING: Can't find title of $issue"; 75 | $issue_title = "N/A ($issue)" . ' 'x30; 76 | } 77 | 78 | my %data = ( 79 | issue => $issue, 80 | activity => $activity_id, 81 | activity_text => $activity_of_id{$activity_id}, 82 | dt => $dt, 83 | time => $entry->{duration}, 84 | comment => $comment, 85 | entry => $entry, 86 | title => $issue_title, 87 | ); 88 | 89 | push @ok_entries, \%data; 90 | } 91 | } 92 | 93 | 94 | if ( $error ) { 95 | say STDERR "Errors in file $file"; 96 | exit 1; 97 | } 98 | exit 0 if $check; 99 | 100 | @ok_entries = sort { $a->{issue} <=> $b->{issue} || 101 | $a->{activity_text} cmp $b->{activity_text} 102 | } @ok_entries; 103 | 104 | for my $entry ( @ok_entries ) { 105 | my $comment = $entry->{comment}; 106 | my @command = ($rmclient, 107 | '--url' => $redmine_url, 108 | '--apikey' => $apikey, 109 | '--date' => $entry->{dt}, 110 | '--hours' => $entry->{time}, 111 | '--issue' => $entry->{issue}, 112 | '--activity' => $entry->{activity}, 113 | '--comment' => qq'"$comment"', 114 | ); 115 | 116 | $tot_time += $entry->{time}; 117 | 118 | printf "%-5d Logging %5.2fh of <%20s> (%2d) on <%30.30s> (\"%s\")\n", 119 | $entry->{issue}, $entry->{time}, 120 | $entry->{activity_text}, $entry->{activity}, 121 | $entry->{title}, $entry->{comment}; 122 | 123 | if ( $insert ) { 124 | say "Running @command"; 125 | if ( ! run_rmclient_insert(@command) ) { 126 | say "FAILED: @command"; 127 | logger("FAILED: @command"); 128 | } 129 | } 130 | } 131 | 132 | printf "Total %5.2fh\n", $tot_time; 133 | 134 | sub run_rmclient_insert { 135 | my @command = @_; 136 | open my $CMD, '-|', "@command" or die "Could not launch command: <@command>"; 137 | my $exitcode; 138 | while (<$CMD>) { 139 | if (/success/) { 140 | $exitcode = 1; 141 | } 142 | if (/error/) { 143 | $exitcode = 0; 144 | } 145 | } 146 | close($CMD); 147 | return $exitcode; 148 | } 149 | 150 | 151 | sub get_issue_of { 152 | my $entry = shift; 153 | my $task = $entry->{ $entry_mapping{task} }; 154 | 155 | 156 | if (exists $issue_of{ $task } ) { 157 | my $issue = $issue_of{$task}; 158 | return $issue; 159 | } 160 | warn "Can't find an entry for:\n"; 161 | say STDERR to_json( $entry ); 162 | return; 163 | } 164 | 165 | sub slurp { 166 | my $file = shift; 167 | open my $F, '<', $file or die; 168 | local $/ = ''; 169 | my $data = <$F>; 170 | return $data; 171 | } 172 | 173 | sub load_config { 174 | my $json = from_json(slurp('config.json')); 175 | return $json; 176 | } 177 | 178 | sub get_apikey { 179 | my $config = shift; 180 | return $config->{'secrets'}{'redmine'}; 181 | } 182 | 183 | sub load_entry_map { 184 | my $config = shift; 185 | return $config->{'entry_map'}; 186 | } 187 | 188 | sub load_issue_map { 189 | my $config = shift; 190 | return $config->{'issue_map'}; 191 | } 192 | 193 | sub logger { 194 | my @msg = @_; 195 | open my $LOG, '>>', 'log.txt' or die; 196 | printf $LOG "%s :: %s", DateTime->now()->iso8601, "@msg"; 197 | close $LOG; 198 | } 199 | 200 | sub get_all_issues { 201 | open my $CLIENT, '-|', "$rmclient --url $redmine_url --apikey $apikey -qi" 202 | or die "Can't get issues"; 203 | my %info; 204 | while (<$CLIENT>) { 205 | chomp; 206 | my ($id, $text) = /^(\d+)\s+(.*)$/; 207 | $info{$id} = $text; 208 | } 209 | 210 | return \%info; 211 | } 212 | 213 | sub _get_specific_issue { 214 | my $issue = shift; 215 | open my $CLIENT, '-|', "$rmclient --url $redmine_url --apikey $apikey -qi$issue 2>/dev/null" 216 | or die "Can't get issues"; 217 | my $text; 218 | while (<$CLIENT>) { 219 | chomp; 220 | ($text) = /^\d+\s+(.*)$/; 221 | } 222 | 223 | return $text; 224 | } 225 | 226 | my $issue_lookup; 227 | sub issue_lookup { 228 | my $issue = shift; 229 | if (! ref $issue_lookup) { 230 | $issue_lookup = get_all_issues(); 231 | } 232 | if ( ! exists $issue_lookup->{$issue} ) { 233 | my $text = _get_specific_issue( $issue ); 234 | if ( ! $text ) { 235 | die "Can't find issue $issue!"; 236 | } 237 | $issue_lookup->{$issue} = $text; 238 | } 239 | return $issue_lookup->{$issue}; 240 | } 241 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------