winfreed.py: some TODO comments
[winfreed.git] / winfreed.py
1 #!/usr/bin/env python
2 #
3 # winfreed - download a selection of Free Software for MS Windows.
4 #
5 # Copyright (C) 2011  Antonio Ospite <ospite@studenti.unina.it>
6 #
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20 import re
21 import os
22 import sys
23 import glob
24 import json
25 import urllib2
26 from progressbar import Bar, ETA, FileTransferSpeed, Percentage, ProgressBar
27
28 # TODO make OUTPUT_DIR and LANGCODE configurable from command line
29 OUTPUT_DIR = 'downloads'
30 LANGCODE = 'en-US'
31
32 # TODO PKG_DIR in $(datadir) or something like that for python projects
33 PKG_DIR = 'pkgs'
34 CHUNK_SIZE = 8192
35
36
37 def get_pkg(json_file):
38     with open(json_file, mode='r') as f:
39         pkg = json.load(f)
40         basename = os.path.basename(json_file)
41         package_name = os.path.splitext(basename)[0]
42         pkg['package_name'] = package_name
43         f.close()
44         return pkg
45
46     return None
47
48
49 def process_all(path, cb):
50     listing = glob.glob(os.path.join(path, '*.json'))
51     for json_file in listing:
52         pkg = get_pkg(json_file)
53         if not pkg:
54             sys.stderr.write("Error: cannot get a pkg for: %s\n" % json_file)
55             continue
56         cb(pkg)
57
58
59 def show(pkg):
60     print 'Package:  ', pkg['package_name']
61     print 'Program:  ', pkg['name']
62     print 'Homepage: ', pkg['homepage']
63     print
64
65
66 def download(pkg):
67     # the "%s" in URLs are meant to be replaced with LANGCODE
68     try:
69         pkg_url = pkg['URL'] % LANGCODE
70     except:
71         pkg_url = pkg['URL']
72         pass
73
74     response = urllib2.urlopen(pkg_url)
75     url = response.geturl()
76
77     filename = ""
78
79     # From http://paste.pound-python.org/show/9545/
80     # TODO: use a proper module to parse HTTP headers
81     if response.info().has_key('Content-Disposition') and len(response.info()['Content-Disposition'].split('filename=')) > 1:
82         # If the response has Content-Disposition, we take file name from it
83         filename = response.info()['Content-Disposition'].split('filename=')[1].decode('utf-8')
84         if filename[0] == '"' or filename[0] == "'":
85             filename = urllib2.unquote(filename.split('"')[1])
86     else:
87         filename =  urllib2.unquote(url.split('/')[-1].decode('utf_8'))
88
89     if filename == "":
90         sys.stderr.write("Debug (%s): filename: %s url: %s\n" % (pkg['package_name'], filename, url))
91         return
92
93     # TODO: Add some integrity verification of downloaded files (md5, sha256?)
94
95     destfile = os.path.join(OUTPUT_DIR, filename)
96     if os.path.exists(destfile):
97         # TODO: check if the file is a full download from previous run,
98         # if not download again discarding the existing file?
99         sys.stderr.write("Warning (%s): %s exists!\n" % (pkg['package_name'], destfile))
100         return
101
102     outfile = open(destfile, mode='w')
103
104     total_size = response.info().getheader('Content-Length').strip()
105     total_size = int(total_size)
106
107     widgets = [pkg['name'], ' ', Percentage(), ' ', Bar(marker='=', left='[', right=']'),
108                ' ', ETA(), ' ', FileTransferSpeed()]
109     pbar = ProgressBar(widgets=widgets, maxval=total_size).start()
110
111     bytes_so_far = 0
112     while 1:
113         chunk = response.read(CHUNK_SIZE)
114         if not chunk:
115             break
116
117         bytes_so_far += len(chunk)
118         outfile.write(chunk)
119         pbar.update(bytes_so_far)
120     pbar.finish()
121
122
123 def show_all():
124     process_all(PKG_DIR, show)
125
126
127 def download_all():
128     if os.path.exists(OUTPUT_DIR) == False:
129         os.mkdir(OUTPUT_DIR, 0755)
130
131     process_all(PKG_DIR, download)
132
133
134 def usage():
135     usage = "winfreed - download a selection of Free Software for MS Windows.\n\n"
136     usage += "usage: %s <COMMAND>\n\n" % sys.argv[0]
137     usage += "COMMANDS:\n"
138     usage += "\tshow        Show info about all the available packages\n"
139     usage += "\tdownload    Download all the packages\n"
140     print usage
141
142 if __name__ == "__main__":
143
144     if len(sys.argv) < 2:
145         usage()
146         sys.exit(1)
147
148     if sys.argv[1] == 'download':
149         download_all()
150     elif sys.argv[1] == 'show':
151         show_all()
152     else:
153         usage()
154         sys.exit(1)
155
156     sys.exit(0)