fixed docstrings
[findit] / src / findit.py
1 #!/usr/bin/env python
2 # -*-coding: utf-8 -*-
3 # vim: sw=4 ts=4 expandtab ai
4 # pylint: disable-msg=C0301
5
6 import gtk
7 import gobject
8 import pango
9 from os import walk
10 from os.path import join, abspath, normcase, basename, \
11                     isdir, getsize, getatime, getmtime, expanduser
12 from heapq import nlargest
13 import gettext
14 import time
15 from sys import platform
16
17 try: 
18     import hildon
19     hildonFound = True
20 except ImportError:
21     hildonFound = False
22
23 try:
24     # Подразумевается, что ru/LC_MESSAGES/program.mo находится в текущем каталоге (sys.path[0])
25     # Для стандартного /usr/share/locale писать gettext.translation('findit')
26     #langRU = gettext.translation('findit', sys.path[0], languages=['ru'])
27     langRU = gettext.translation('findit')
28     langRU.install()
29 except IOError:
30     # Закомментировать перед использованием pygettext
31     def _(text): 
32         return text
33
34
35 ### Common functions ###########################################################
36
37 # Функция которая возвращает строку из числа и единиц для столбца "Размер"("Size")
38 def size_convert(size):
39     """Return string with file size in b or Kb or Mb or Gb or Tb."""
40     for i, unit in enumerate(['%d b', '%.1f Kb', '%.2f Mb', '%.3f Gb', '%.4f Tb']):
41         if size < 1024**(i+1):
42             return unit % (size/1024.**i)
43     return '>1024 Tb'
44
45 # Функция поставляющая размер файла и путь к нему
46 def filegetter(startdir, obj):
47     """Generator of file sizes and paths based on os.walk."""
48     # Список игнорируемых каталогов:
49     ignore_dirs = ['/dev', '/proc', '/sys', '/mnt']
50     # Проходим по всем папкам вглубь от заданного пути
51     for dirpath, dirnames, fnames in walk(startdir):
52     # Исключаем каталоги из поиска в соответствии со списком исключений
53         for ign_dir in ignore_dirs[:]:
54             for dirname in dirnames[:]:
55                 if ign_dir == normcase(join(abspath(dirpath), dirname)):
56                     dirnames.remove(dirname)
57                     ignore_dirs.remove(ign_dir)
58
59         for fname in fnames:
60             flpath = abspath(join(dirpath, fname))
61             # Выводим текущий опрашиваемый файл в строку статуса
62             obj.currFileLbl.set_text(flpath)
63             # обновляем окно
64             gtk.main_iteration()
65             # Останавливаем цикл по нажатию кнопки стоп
66             if obj.stopit:
67                 obj.stopit = False
68                 raise StopIteration
69             # Проверяем можем ли мы определить размер файла - иначе пропускаем его
70             try:
71                 flsize = getsize(flpath)
72                 # Возвращаем размер и полный путь файла
73                 yield flsize, flpath
74             except OSError:
75                 continue
76
77 # Fullscreen
78 def toggle_fullscreen(obj):
79     """Switch fullscreen on/off."""
80     if obj.fullscreen:
81         obj.window.unfullscreen()
82     else: 
83         obj.window.fullscreen()
84     obj.fullscreen = not obj.fullscreen
85
86 # Нажатие на кнопку клавиатуры
87 def on_key_press(obj, event):
88     """Key press callback."""
89     # Toggle fullscreen on Maemo when hw key is pressed
90     if hildonFound and event.keyval == gtk.keysyms.F6:
91         toggle_fullscreen(obj)
92
93 ### Properties dialog ##########################################################
94
95 class PropertiesDialog(gtk.Dialog):
96     """File property dialog window."""
97
98     def __init__(self, path, size, bytesize):
99         """Create&show file properties dialog."""
100         gtk.Dialog.__init__(self)
101         self.set_title( _('File properties') )
102         self.set_transient_for(app)
103         self.set_wmclass('PropertiesDialog', 'FindIT')
104         self.add_buttons(gtk.STOCK_OK, gtk.RESPONSE_OK)
105         self.set_resizable(False)
106
107         # Достаем свойства выбранного файла
108         name = basename(path)
109         access = time.strftime('%x %X', time.localtime(getatime(path)))
110         modified = time.strftime('%x %X', time.localtime(getmtime(path)))
111
112         # Таблица надписей
113         table = gtk.Table()
114         table.set_border_width(10)
115         table.set_col_spacings(10)
116         table.set_row_spacings(10)
117
118         # Надписи (подпись: значение)
119         nameLbl = gtk.Label( _('Name') )
120         nameValueLbl = gtk.Label(name)
121
122         sizeLbl = gtk.Label( _('Size') )
123         sizeValueLbl = gtk.Label(size + ' (' + `bytesize` + ' b)')
124
125         accessLbl = gtk.Label( _('Opened') )
126         accessValueLbl = gtk.Label(access)
127
128         modifiedLbl = gtk.Label( _('Modified') )
129         modifiedValueLbl = gtk.Label(modified)
130
131         # Список надписей
132         lbls = [(nameLbl,   nameValueLbl),   (sizeLbl,     sizeValueLbl),
133                 (accessLbl, accessValueLbl), (modifiedLbl, modifiedValueLbl)]
134
135         # Упаковка надписей в таблицу и выравнивание
136         for i, lbl in enumerate(lbls):
137             name, value = lbl
138             table.attach(name, 0, 1, i, i+1)
139             table.attach(value, 1, 2, i, i+1)
140             name.set_alignment(1, 0.5)
141             value.set_alignment(0, 0.5)
142
143         # Упаковка таблицы в vbox диалога
144         self.vbox.add(table)
145         self.show_all()
146         self.run()
147         self.destroy()
148
149 ### Main window ################################################################
150
151 class MainWindow(gtk.Window):
152     """Main window class."""
153
154     # Окно сообщения заданного типа с заданным текстом
155     def mess_window(self, mestype, content):
156         """Show popup message window."""
157         dialog = gtk.MessageDialog(parent=self, flags=gtk.DIALOG_MODAL,
158                                    type=mestype, buttons=gtk.BUTTONS_OK,
159                                    message_format=content)
160         dialog.set_wmclass('ErrorDialog', 'FindIT')
161         dialog.set_title( _('Error!') )
162         dialog.run()
163         dialog.destroy()
164
165     # Функция выполняющаяся при нажатии на кнопку "Показать"
166     def start_print(self, widget):
167         """Start file search. Button "Go" activate callback."""         
168         self.start_path = self.srch_p_entr.get_text()
169         # Проверяем правильное ли значение введено
170         if isdir(self.start_path):
171             self.butt_start.set_sensitive(False)
172             self.butt_stop.set_sensitive(True)
173             self.propertiesBtn.set_sensitive(False)
174             # Получаем значение количества файлов из SpinButton
175             self.fl_cnt = int( self.file_cnt.get_value() )
176             # Очищаем список
177             self.treestore.clear()
178             # Получаем нужное количество самых больших файлов
179             for fsize, fpath in nlargest(self.fl_cnt, filegetter(self.start_path, self)):
180                 # Возвращаем значения в treeview в таком порядке - путь,
181                 # размер в Мб строкой и размер в байтах
182                 # self.treestore.append(None, [fpath.replace(self.start_path,'', 1),
183                 #        size_convert(fsize), fsize])
184
185                 # Выдает какую-то перманентную ошибку при присвоении значений treestore -
186                 # кто увидит скажите - нужна статистика
187                 try: 
188                     self.treestore.append(None, [fpath, size_convert(fsize), fsize])
189                 except SystemError:
190 #                    print 'error', fpath, size_convert(fsize), fsize
191                     self.mess_window('error','Error in %s' % fpath)
192             self.butt_start.set_sensitive(True)
193             self.butt_stop.set_sensitive(False)
194             self.propertiesBtn.set_sensitive(True)
195             self.srch_p_entr.grab_focus()
196         else:
197             # Иначе выводим окошко с ошибкой
198             self.mess_window('error', _('Invalid directory') )
199
200     # Функция выполняющаяся при нажатии на кнопку "Стоп"
201     def stop_print(self, widget):
202         """Stop search. "Stop" button clicked callback."""
203         self.stopit = True
204
205     # Функция выполняющаяся при нажатии на кнопку "Свойства файла"
206     def show_properties_dialog(self, *args):
207         """Show property dialog window."""
208         selection = self.treeview.get_selection()
209         (model, it) = selection.get_selected()
210         try:
211             path = model.get_value(it, 0)
212             size = model.get_value(it, 1)
213             bytesize = model.get_value(it, 2)
214         except (TypeError, ValueError):
215             self.mess_window('error', _('Please select file') )
216             return
217         PropertiesDialog(path, size, bytesize)
218
219     ### Window initialization ##################################################
220
221     def __init__(self, win_width, win_height, st_path):
222         """Create MainWindow."""
223         # Создаем новое окно
224         gtk.Window.__init__(self)
225         self.set_default_size(win_width, win_height)
226         self.set_border_width(4)
227         self.fullscreen = False
228         self.connect('delete_event', gtk.main_quit)
229         self.connect("key-press-event", on_key_press)
230         self.set_wmclass('MainWindow', 'FindIT')
231
232         #########  Добавляем элементы ################
233         # 1. Строка ввода каталога с которого начинать поиск
234         #    переменная в которой храниться стартовый каталог = self.start_path
235         self.srch_p_entr = gtk.Entry()
236         self.start_path = st_path
237         self.srch_p_entr.set_text(self.start_path)
238         # Отключаем автокапитализацию(ввод первой буквы заглавной) на таблетке
239         if hildonFound:
240             self.srch_p_entr.set_property("hildon-input-mode", 'full')
241         # Нажатие Enter в поле ввода
242         self.srch_p_entr.connect("activate", self.start_print)
243
244         # 2. Кнопка "Обзор"
245
246         # 3. Надпись1 "Количество отображаемых файлов:"
247         label1 = gtk.Label( _('Files quantity') )
248
249         # 4. Окошко ввода количества файлов, мин значение=1 макс=65536 по умолчанию 10
250         #    данные храняться в переменной self.fl_cnt
251         self.fl_cnt = 10
252         if hildonFound:
253             self.file_cnt = hildon.NumberEditor(1, 99)
254             self.file_cnt.set_value(self.fl_cnt)
255         else:
256             adj = gtk.Adjustment(self.fl_cnt, 1, 65536, 1, 5, 0)
257             self.file_cnt = gtk.SpinButton(adj, 0, 0)
258
259         # 5.1 Кнопка "Показать"
260         self.butt_start = gtk.Button( _('Go') )
261         self.butt_start.connect('released', self.start_print)
262
263         # 5.2 Кнопка "Остановить"
264         self.butt_stop = gtk.Button( _('Stop') )
265         self.butt_stop.set_sensitive(False)
266         self.butt_stop.connect('clicked', self.stop_print)
267         self.stopit = False
268
269         # 5.3 Кнопка "Свойства файла"
270         self.propertiesBtn = gtk.Button( _('File properties') )
271         self.propertiesBtn.connect('clicked', self.show_properties_dialog)
272         self.propertiesBtn.set_sensitive(False)
273
274         # 6. Закладки
275
276         # 6.1 Список файлов
277         scrollwind = gtk.ScrolledWindow()
278         scrollwind.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
279
280         # Определяем переменную в которой будет храниться выводимый список
281         self.treestore = gtk.TreeStore(str, str, int)
282         self.treeview = gtk.TreeView(self.treestore)
283         # На таблетке не отображаються заголовки столбцов по умолчанию -
284         # след строка заставляет их отображаться принудительно
285         self.treeview.set_headers_visible(1)
286         self.treeview.connect('row-activated', self.show_properties_dialog)
287
288         self.treestore.append(None, ['', '', 0])
289
290         # Создаем и настраиваем колонку с размером файла
291         size_col = gtk.TreeViewColumn( _('Size') )
292         cell = gtk.CellRendererText()
293         cell.set_property('width', 90)
294         size_col.pack_start(cell, True)
295         size_col.add_attribute(cell, 'text', 1)
296         self.treeview.append_column(size_col)
297         # Создаем и настраиваем колонку с именем файла
298         path_col = gtk.TreeViewColumn( _('Path') )
299         cell2 = gtk.CellRendererText()
300         path_col.pack_start(cell2, True)
301         path_col.add_attribute(cell2, 'text', 0)
302         self.treeview.append_column(path_col)
303
304         # Добавляем сортировку для колонок
305         self.treeview.set_search_column(1)
306         path_col.set_sort_column_id(0)
307         size_col.set_sort_column_id(2)
308
309         # 6.2 Надпись "Найти"
310
311         # 6.3 Строка выводящая текущий осматриваемый файл
312         self.currFileLbl = gtk.Label()
313         self.currFileLbl.set_alignment(0, 0.5)
314         self.currFileLbl.set_ellipsize(pango.ELLIPSIZE_MIDDLE)
315         self.currFileLbl.set_padding(2, 2)
316         currFileFrm = gtk.Frame()
317         currFileFrm.add(self.currFileLbl)
318
319         #########  Упаковываем элементы ################
320         # Создаем основной вертикальный контейнер
321         main_Vbox = gtk.VBox(False, 4)
322
323         # Создаем вспомогательный горизонтальный контейнер для Надписи1,
324         # окошка ввода количества файлов и кнопки "Показать"
325         hbox1 = gtk.HBox(False, 5)
326         # Добавляем вышеперечисленные элементы во вспомогат. контейнер
327         hbox1.pack_start(label1, False, False, 5)
328         hbox1.pack_start(self.file_cnt, False, False, 0)
329         hbox1.pack_start(self.butt_start, True, True, 0)
330         hbox1.pack_start(self.butt_stop, True, True, 0)
331         hbox1.pack_start(self.propertiesBtn, True, True, 0)
332
333         # Добавляем элементы в основной контейнер
334         main_Vbox.pack_start(self.srch_p_entr, False, False, 0)
335         main_Vbox.pack_start(hbox1, False, False, 0)
336         scrollwind.add(self.treeview)
337         main_Vbox.pack_start(scrollwind, True, True, 0)
338         main_Vbox.pack_start(currFileFrm, False, False, 0)
339
340         self.add(main_Vbox)
341
342     def run(self):
343         """Show all widgets and run gtk.main()."""
344         self.show_all()
345         gtk.main()
346
347
348 ### Main call ##################################################################
349
350 if __name__ == '__main__':
351     gobject.set_application_name( _('FindIT') )
352
353     if platform == 'win32':
354         startpath = 'c:\\'
355     else:
356         startpath = expanduser('~')
357
358     app = MainWindow(575, 345, startpath)
359     app.run()