annotate frontends/jp/jp @ 156:a216dfbb0d50

jp: added default value in --profile option's help
author Goffi <goffi@goffi.org>
date Wed, 04 Aug 2010 12:00:25 +0800
parents cb904fa7de3c
children 8a2053de6f8c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
goffi@necton2
parents:
diff changeset
1 #! /usr/bin/python
goffi@necton2
parents:
diff changeset
2 # -*- coding: utf-8 -*-
goffi@necton2
parents:
diff changeset
3
goffi@necton2
parents:
diff changeset
4 """
goffi@necton2
parents:
diff changeset
5 jp: a SAT command line tool
57
a5b5fb5fc9fd updated README and copyright note
Goffi <goffi@goffi.org>
parents: 22
diff changeset
6 Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org)
0
goffi@necton2
parents:
diff changeset
7
goffi@necton2
parents:
diff changeset
8 This program is free software: you can redistribute it and/or modify
goffi@necton2
parents:
diff changeset
9 it under the terms of the GNU General Public License as published by
goffi@necton2
parents:
diff changeset
10 the Free Software Foundation, either version 3 of the License, or
goffi@necton2
parents:
diff changeset
11 (at your option) any later version.
goffi@necton2
parents:
diff changeset
12
goffi@necton2
parents:
diff changeset
13 This program is distributed in the hope that it will be useful,
goffi@necton2
parents:
diff changeset
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
goffi@necton2
parents:
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
goffi@necton2
parents:
diff changeset
16 GNU General Public License for more details.
goffi@necton2
parents:
diff changeset
17
goffi@necton2
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
goffi@necton2
parents:
diff changeset
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
goffi@necton2
parents:
diff changeset
20 """
goffi@necton2
parents:
diff changeset
21
goffi@necton2
parents:
diff changeset
22 #consts
goffi@necton2
parents:
diff changeset
23 name = "jp"
goffi@necton2
parents:
diff changeset
24 version = "0.0.1"
57
a5b5fb5fc9fd updated README and copyright note
Goffi <goffi@goffi.org>
parents: 22
diff changeset
25 about = name+" v"+version+""" (c) Jérôme Poisson (aka Goffi) 2009, 2010
0
goffi@necton2
parents:
diff changeset
26
goffi@necton2
parents:
diff changeset
27 ---
57
a5b5fb5fc9fd updated README and copyright note
Goffi <goffi@goffi.org>
parents: 22
diff changeset
28 """+name+""" Copyright (C) 2009, 2010 Jérôme Poisson (aka Goffi)
0
goffi@necton2
parents:
diff changeset
29 This program comes with ABSOLUTELY NO WARRANTY;
goffi@necton2
parents:
diff changeset
30 This is free software, and you are welcome to redistribute it
goffi@necton2
parents:
diff changeset
31 under certain conditions.
goffi@necton2
parents:
diff changeset
32 ---
goffi@necton2
parents:
diff changeset
33
goffi@necton2
parents:
diff changeset
34 This software is a command line tool for jabber
goffi@necton2
parents:
diff changeset
35 Get the latest version at http://www.goffi.org
goffi@necton2
parents:
diff changeset
36 """
goffi@necton2
parents:
diff changeset
37
goffi@necton2
parents:
diff changeset
38 global pbar_available
goffi@necton2
parents:
diff changeset
39 pbar_available = True #checked before using ProgressBar
goffi@necton2
parents:
diff changeset
40
goffi@necton2
parents:
diff changeset
41 ### logging ###
goffi@necton2
parents:
diff changeset
42 import logging
goffi@necton2
parents:
diff changeset
43 from logging import debug, info, error, warning
goffi@necton2
parents:
diff changeset
44 logging.basicConfig(level=logging.DEBUG,
goffi@necton2
parents:
diff changeset
45 format='%(message)s')
goffi@necton2
parents:
diff changeset
46 ###
goffi@necton2
parents:
diff changeset
47
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
48 import gettext
Goffi <goffi@goffi.org>
parents: 57
diff changeset
49 gettext.install('jp', "i18n", unicode=True)
Goffi <goffi@goffi.org>
parents: 57
diff changeset
50
0
goffi@necton2
parents:
diff changeset
51 import sys
goffi@necton2
parents:
diff changeset
52 import os
goffi@necton2
parents:
diff changeset
53 from os.path import abspath, basename, dirname
goffi@necton2
parents:
diff changeset
54 from optparse import OptionParser
goffi@necton2
parents:
diff changeset
55 import pdb
goffi@necton2
parents:
diff changeset
56 from tools.jid import JID
goffi@necton2
parents:
diff changeset
57 import gobject
goffi@necton2
parents:
diff changeset
58 from sat_bridge_frontend.DBus import DBusBridgeFrontend
goffi@necton2
parents:
diff changeset
59 import tarfile
goffi@necton2
parents:
diff changeset
60 try:
goffi@necton2
parents:
diff changeset
61 from progressbar import ProgressBar, Percentage, Bar, ETA, FileTransferSpeed
goffi@necton2
parents:
diff changeset
62 except ImportError, e:
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
63 info (_('ProgressBar not available, please download it at http://pypi.python.org/pypi/progressbar'))
Goffi <goffi@goffi.org>
parents: 57
diff changeset
64 info (_('Progress bar deactivated\n--\n'))
0
goffi@necton2
parents:
diff changeset
65 pbar_available=False
goffi@necton2
parents:
diff changeset
66
goffi@necton2
parents:
diff changeset
67
goffi@necton2
parents:
diff changeset
68
goffi@necton2
parents:
diff changeset
69
goffi@necton2
parents:
diff changeset
70 class JP():
goffi@necton2
parents:
diff changeset
71 def __init__(self):
goffi@necton2
parents:
diff changeset
72 self.bridge=DBusBridgeFrontend()
goffi@necton2
parents:
diff changeset
73 self.transfert_id = None
goffi@necton2
parents:
diff changeset
74
goffi@necton2
parents:
diff changeset
75 def check_options(self):
goffi@necton2
parents:
diff changeset
76 """Check command line options"""
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
77 usage=_("""
0
goffi@necton2
parents:
diff changeset
78 %prog [options] [FILE1 FILE2 ...] JID
goffi@necton2
parents:
diff changeset
79 %prog -w [options] [JID1 JID2 ...]
goffi@necton2
parents:
diff changeset
80
goffi@necton2
parents:
diff changeset
81 %prog --help for options list
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
82 """)
0
goffi@necton2
parents:
diff changeset
83 parser = OptionParser(usage=usage,version=about)
goffi@necton2
parents:
diff changeset
84
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
85 parser.add_option("-p", "--profile", action="store", type="string", default='@DEFAULT@',
156
a216dfbb0d50 jp: added default value in --profile option's help
Goffi <goffi@goffi.org>
parents: 110
diff changeset
86 help=_("Use PROFILE profile key (default: %default)"))
0
goffi@necton2
parents:
diff changeset
87 parser.add_option("-b", "--bz2", action="store_true", default=False,
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
88 help=_("Make a bzip2 tarball"))
0
goffi@necton2
parents:
diff changeset
89 parser.add_option("-w", "--wait-file", action="store_true", default=False,
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
90 help=_("Wait for a file to be sent by a contact"))
0
goffi@necton2
parents:
diff changeset
91 parser.add_option("-m", "--multiple", action="store_true", default=False,
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
92 help=_("Accept multiple files (you'll have to stop manually)"))
0
goffi@necton2
parents:
diff changeset
93 parser.add_option("-f", "--force", action="store_true", default=False,
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
94 help=_("Force overwritting of existing files"))
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
95 parser.add_option("-g", "--progress", action="store_true", default=False,
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
96 help=_("Show progress bar"))
0
goffi@necton2
parents:
diff changeset
97 parser.add_option("-s", "--separate", action="store_true", default=False,
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
98 help=_("Separate xmpp messages: send one message per line instead of one message alone."))
0
goffi@necton2
parents:
diff changeset
99 parser.add_option("-n", "--new-line", action="store_true", default=False,
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
100 help=_("Add a new line at the beginning of the input (usefull for ascii art ;))"))
0
goffi@necton2
parents:
diff changeset
101
goffi@necton2
parents:
diff changeset
102 (self.options, args) = parser.parse_args()
goffi@necton2
parents:
diff changeset
103
goffi@necton2
parents:
diff changeset
104 if len(args) < 1 and not self.options.wait_file:
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
105 parser.error(_("You must specify the destination JID (Jabber ID)").encode('utf-8'))
0
goffi@necton2
parents:
diff changeset
106
goffi@necton2
parents:
diff changeset
107 if self.options.wait_file:
goffi@necton2
parents:
diff changeset
108 #several jid
goffi@necton2
parents:
diff changeset
109 self.dest_jids = args
goffi@necton2
parents:
diff changeset
110 else:
goffi@necton2
parents:
diff changeset
111 #one dest_jid, other args are files
goffi@necton2
parents:
diff changeset
112 self.dest_jid = JID(args[-1])
goffi@necton2
parents:
diff changeset
113 if not self.dest_jid.is_valid:
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
114 error (_("%s is not a valid JID !"), self.dest_jid)
0
goffi@necton2
parents:
diff changeset
115 exit(1)
goffi@necton2
parents:
diff changeset
116 self.files = args[:-1]
goffi@necton2
parents:
diff changeset
117
goffi@necton2
parents:
diff changeset
118 if not pbar_available and self.options.progress:
goffi@necton2
parents:
diff changeset
119 self.options.progress = False
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
120 error (_("Option progress is not available, deactivated."))
0
goffi@necton2
parents:
diff changeset
121
goffi@necton2
parents:
diff changeset
122 if self.options.progress or self.options.wait_file:
goffi@necton2
parents:
diff changeset
123 self.start_loop = True #We have to use loop for these options
goffi@necton2
parents:
diff changeset
124 else:
goffi@necton2
parents:
diff changeset
125 self.start_loop = False
goffi@necton2
parents:
diff changeset
126
goffi@necton2
parents:
diff changeset
127
goffi@necton2
parents:
diff changeset
128 return args
goffi@necton2
parents:
diff changeset
129
goffi@necton2
parents:
diff changeset
130 def check_jabber_status(self):
goffi@necton2
parents:
diff changeset
131 """Check that jabber status is allright"""
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
132
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
133 self.profile = self.bridge.getProfileName(self.options.profile)
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
134 if not self.profile:
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
135 error(_("The profile asked doesn't exist"))
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
136 exit(1)
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
137
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
138 if not self.bridge.isConnected(self.profile):
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
139 error(_(u"SàT is not conneted, please connect before using jp"))
0
goffi@necton2
parents:
diff changeset
140 exit(1)
goffi@necton2
parents:
diff changeset
141
goffi@necton2
parents:
diff changeset
142
goffi@necton2
parents:
diff changeset
143 def send_stdin(self):
goffi@necton2
parents:
diff changeset
144 """Send incomming data on stdin to jabber contact"""
goffi@necton2
parents:
diff changeset
145 header = "\n" if self.options.new_line else ""
goffi@necton2
parents:
diff changeset
146
goffi@necton2
parents:
diff changeset
147 if self.options.separate: #we send stdin in several messages
goffi@necton2
parents:
diff changeset
148 if header:
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
149 self.bridge.sendMessage(self.dest_jid, header, profile_key=self.profile)
0
goffi@necton2
parents:
diff changeset
150 while (True):
goffi@necton2
parents:
diff changeset
151 line = sys.stdin.readline()
goffi@necton2
parents:
diff changeset
152 if not line:
goffi@necton2
parents:
diff changeset
153 break
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
154 self.bridge.sendMessage(self.dest_jid, line.replace("\n",""), profile_key=self.profile)
0
goffi@necton2
parents:
diff changeset
155 else:
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
156 self.bridge.sendMessage(self.dest_jid, header + "".join(sys.stdin.readlines()), profile_key=self.profile)
0
goffi@necton2
parents:
diff changeset
157
goffi@necton2
parents:
diff changeset
158 def send_files(self):
goffi@necton2
parents:
diff changeset
159 """Send files to jabber contact"""
goffi@necton2
parents:
diff changeset
160
goffi@necton2
parents:
diff changeset
161 for file in self.files:
goffi@necton2
parents:
diff changeset
162 if not os.path.exists(file):
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
163 error (_("File [%s] doesn't exist !") % file)
0
goffi@necton2
parents:
diff changeset
164 exit(1)
goffi@necton2
parents:
diff changeset
165 if not self.options.bz2 and os.path.isdir(file):
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
166 error (_("[%s] is a dir ! Please send files inside or use compression") % file)
0
goffi@necton2
parents:
diff changeset
167 exit(1)
goffi@necton2
parents:
diff changeset
168
goffi@necton2
parents:
diff changeset
169 if self.options.bz2:
goffi@necton2
parents:
diff changeset
170 tmpfile = (basename(self.files[0]) or basename(dirname(self.files[0])) ) + '.tar.bz2' #FIXME: tmp, need an algorithm to find a good name/path
goffi@necton2
parents:
diff changeset
171 if os.path.exists(tmpfile):
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
172 error (_("tmp file (%s) already exists ! Please remove it"), tmpfile)
0
goffi@necton2
parents:
diff changeset
173 exit(1)
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
174 warning(_("bz2 is an experimental option at an early dev stage, use with caution"))
0
goffi@necton2
parents:
diff changeset
175 #FIXME: check free space, writting perm, tmp dir, filename (watch for OS used)
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
176 info(_("Starting compression, please wait..."))
0
goffi@necton2
parents:
diff changeset
177 sys.stdout.flush()
goffi@necton2
parents:
diff changeset
178 bz2=tarfile.open(tmpfile, "w:bz2")
goffi@necton2
parents:
diff changeset
179 for file in self.files:
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
180 info(_("Adding %s"), file)
0
goffi@necton2
parents:
diff changeset
181 bz2.add(file)
goffi@necton2
parents:
diff changeset
182 bz2.close()
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
183 info(_("OK !"))
0
goffi@necton2
parents:
diff changeset
184 path = abspath(tmpfile)
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
185 self.transfert_id = self.bridge.sendFile(self.dest_jid, path, profile_key=self.profile)
0
goffi@necton2
parents:
diff changeset
186 else:
goffi@necton2
parents:
diff changeset
187 for file in self.files:
goffi@necton2
parents:
diff changeset
188 path = abspath(file)
110
cb904fa7de3c jp: profile management (new option: --profile)
Goffi <goffi@goffi.org>
parents: 70
diff changeset
189 self.transfert_id = self.bridge.sendFile(self.dest_jid, path, profile_key=self.profile) #FIXME: show progress only for last transfert_id
0
goffi@necton2
parents:
diff changeset
190
goffi@necton2
parents:
diff changeset
191 #TODO: manage ProgressBar
goffi@necton2
parents:
diff changeset
192
goffi@necton2
parents:
diff changeset
193 def askConfirmation(self, type, id, data):
goffi@necton2
parents:
diff changeset
194 """CB used for file transfert, accept files depending on parameters"""
goffi@necton2
parents:
diff changeset
195 answer_data={}
goffi@necton2
parents:
diff changeset
196 if type == "FILE_TRANSFERT":
goffi@necton2
parents:
diff changeset
197 if self.dest_jids and not data['from'] in self.dest_jids:
goffi@necton2
parents:
diff changeset
198 return #file is not sent by a filtered jid
goffi@necton2
parents:
diff changeset
199
goffi@necton2
parents:
diff changeset
200 answer_data["dest_path"] = os.getcwd()+'/'+data['filename']
goffi@necton2
parents:
diff changeset
201
goffi@necton2
parents:
diff changeset
202 if self.options.force or not os.path.exists(answer_data["dest_path"]):
goffi@necton2
parents:
diff changeset
203 self.bridge.confirmationAnswer(id, True, answer_data)
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
204 info(_("Accepted file [%(filename)s] from %(sender)s") % {'filename':data['filename'], 'sender':data['from']})
0
goffi@necton2
parents:
diff changeset
205 self.transfert_id = id
goffi@necton2
parents:
diff changeset
206 else:
goffi@necton2
parents:
diff changeset
207 self.bridge.confirmationAnswer(id, False, answer_data)
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
208 warning(_("Refused file [%(filename)s] from %(sender)s: a file with the same name already exist") % {'filename':data['filename'], 'sender':data['from']})
0
goffi@necton2
parents:
diff changeset
209
goffi@necton2
parents:
diff changeset
210
goffi@necton2
parents:
diff changeset
211 if not self.options.multiple and not self.options.progress:
goffi@necton2
parents:
diff changeset
212 #we just accept one file
goffi@necton2
parents:
diff changeset
213 self.loop.quit()
goffi@necton2
parents:
diff changeset
214
22
bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
215 def actionResult(self, type, id, data):
bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button.
Goffi <goffi@goffi.org>
parents: 0
diff changeset
216 #FIXME
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
217 info (_("FIXME: actionResult not implemented"))
0
goffi@necton2
parents:
diff changeset
218
goffi@necton2
parents:
diff changeset
219 def wait_file(self):
goffi@necton2
parents:
diff changeset
220 """Wait for a file and write it on local dir"""
goffi@necton2
parents:
diff changeset
221 self.bridge.register("askConfirmation", self.askConfirmation, "request")
goffi@necton2
parents:
diff changeset
222
goffi@necton2
parents:
diff changeset
223 def progressCB(self):
goffi@necton2
parents:
diff changeset
224 if self.transfert_id:
goffi@necton2
parents:
diff changeset
225 data = self.bridge.getProgress(self.transfert_id)
goffi@necton2
parents:
diff changeset
226 if data:
goffi@necton2
parents:
diff changeset
227 if not data['position']:
goffi@necton2
parents:
diff changeset
228 data['position'] = '0'
goffi@necton2
parents:
diff changeset
229 if not self.pbar:
goffi@necton2
parents:
diff changeset
230 #first answer, we must construct the bar
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
231 self.pbar = ProgressBar(int(data['size']),[_("Progress: "),Percentage()," ",Bar()," ",FileTransferSpeed()," ",ETA()])
0
goffi@necton2
parents:
diff changeset
232 self.pbar.start()
goffi@necton2
parents:
diff changeset
233
goffi@necton2
parents:
diff changeset
234 self.pbar.update(int(data['position']))
goffi@necton2
parents:
diff changeset
235 elif self.pbar:
goffi@necton2
parents:
diff changeset
236 self.pbar.finish()
goffi@necton2
parents:
diff changeset
237 if not self.options.multiple:
goffi@necton2
parents:
diff changeset
238 self.loop.quit()
goffi@necton2
parents:
diff changeset
239 return False
goffi@necton2
parents:
diff changeset
240
goffi@necton2
parents:
diff changeset
241 return True
goffi@necton2
parents:
diff changeset
242
goffi@necton2
parents:
diff changeset
243 def go(self):
goffi@necton2
parents:
diff changeset
244 self.check_options()
goffi@necton2
parents:
diff changeset
245 self.check_jabber_status()
goffi@necton2
parents:
diff changeset
246 if self.options.wait_file:
goffi@necton2
parents:
diff changeset
247 self.wait_file()
goffi@necton2
parents:
diff changeset
248 else:
goffi@necton2
parents:
diff changeset
249 if not self.files: #we send message only if there are no files to send
goffi@necton2
parents:
diff changeset
250 self.send_stdin()
goffi@necton2
parents:
diff changeset
251 else:
goffi@necton2
parents:
diff changeset
252 self.send_files()
goffi@necton2
parents:
diff changeset
253
goffi@necton2
parents:
diff changeset
254 if self.start_loop:
goffi@necton2
parents:
diff changeset
255 self.loop = gobject.MainLoop()
goffi@necton2
parents:
diff changeset
256 if self.options.progress:
goffi@necton2
parents:
diff changeset
257 self.pbar = None
goffi@necton2
parents:
diff changeset
258 gobject.timeout_add(10, self.progressCB)
goffi@necton2
parents:
diff changeset
259 try:
goffi@necton2
parents:
diff changeset
260 self.loop.run()
goffi@necton2
parents:
diff changeset
261 except KeyboardInterrupt:
70
Goffi <goffi@goffi.org>
parents: 57
diff changeset
262 info(_("User interruption: good bye"))
0
goffi@necton2
parents:
diff changeset
263
goffi@necton2
parents:
diff changeset
264
goffi@necton2
parents:
diff changeset
265 if __name__ == "__main__":
goffi@necton2
parents:
diff changeset
266 jp = JP()
goffi@necton2
parents:
diff changeset
267 jp.go()