1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
#!/usr/bin/python
# -*- coding: latin1 -*-
### Copyright (C) 2011-2012 Damon Lynch <damonlynch@gmail.com>
### This program is free software; you can redistribute it and/or modify
### it under the terms of the GNU General Public License as published by
### the Free Software Foundation; either version 2 of the License, or
### (at your option) any later version.
### This program is distributed in the hope that it will be useful,
### but WITHOUT ANY WARRANTY; without even the implied warranty of
### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
### GNU General Public License for more details.
### You should have received a copy of the GNU General Public License
### along with this program; if not, write to the Free Software
### Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
### USA
import os
import multiprocessing
import re
import gio
import gtk
import pyexiv2
import rpdmultiprocessing as rpdmp
import rpdfile
import prefsrapid
import logging
logger = multiprocessing.get_logger()
# python whitespace is significant - don't remove the leading whitespace on
# the second line
file_attributes = "standard::name,standard::display-name,\
standard::type,standard::size,time::modified,access::can-read,id::file"
def get_associated_file(full_file_name_no_ext, extensions_to_check):
f = None
for e in extensions_to_check:
if os.path.exists(full_file_name_no_ext + '.' + e):
f = full_file_name_no_ext + '.' + e
break
if os.path.exists(full_file_name_no_ext + '.' + e.upper()):
f = full_file_name_no_ext + '.' + e.upper()
break
return f
def get_audio_file(full_file_name_no_ext):
"""
Checks to see if an audio file of the same name is in the same directory
as the file. Expects a full path to be part of the file name.
Returns the filename, including path, if found, else returns None.
"""
return get_associated_file(full_file_name_no_ext, rpdfile.AUDIO_EXTENSIONS)
def get_video_THM_file(full_file_name_no_ext):
"""
Checks to see if a thumbnail file (THM) is in the same directory as the
file. Expects a full path to be part of the file name.
Returns the filename, including path, if found, else returns None.
"""
return get_associated_file(full_file_name_no_ext, rpdfile.VIDEO_THUMBNAIL_EXTENSIONS)
class Scan(multiprocessing.Process):
"""Scans the given path for files of a specified type.
Returns results in batches, finishing with a total of the size of all the
files in bytes.
"""
def __init__(self, path, ignored_paths, use_re_ignored_paths,
batch_size, results_pipe,
terminate_queue, run_event):
"""Setup values needed to conduct the scan.
'path' is a string of the path to be scanned, which is passed to gio.
'ignored_paths' is a list of paths that should not be scanned. Any path
ending with one of the values will be ignored.
'use_re_ignored_paths': if true, pytho regular expressions will be used
to determine which paths to ignore
'batch_size' is the number of files that should be sent back to the
calling function at one time.
'results_pipe' is a connection on which to send the results.
'terminate_queue' is a queue whose sole purpose is to notify the
process that it should terminate and not return any results.
'run_event' is an Event that is used to temporarily halt execution.
"""
multiprocessing.Process.__init__(self)
self.path = path
self.ignored_paths = ignored_paths
self.use_re_ignored_paths = use_re_ignored_paths
self.results_pipe = results_pipe
self.terminate_queue = terminate_queue
self.run_event = run_event
self.batch_size = batch_size
self.counter = 0
self.files_scanned = 0
self.files = []
self.file_type_counter = rpdfile.FileTypeCounter()
def _gio_scan(self, path, file_size_sum):
"""recursive function to scan a directory and its subdirectories
for photos and possibly videos"""
children = path.enumerate_children(file_attributes)
for child in children:
# pause if instructed by the caller
self.run_event.wait()
if not self.terminate_queue.empty():
x = self.terminate_queue.get()
# terminate immediately
logger.info("terminating scan...")
self.files = []
return None
# only collect files and scan in directories we can actually read
# cannot assume that users will download only from memory cards
if child.get_attribute_boolean(gio.FILE_ATTRIBUTE_ACCESS_CAN_READ):
file_type = child.get_file_type()
name = child.get_name()
if file_type == gio.FILE_TYPE_DIRECTORY:
if not self.ignore_this_path(name):
file_size_sum = self._gio_scan(path.get_child(name),
file_size_sum)
if file_size_sum is None:
return None
elif file_type == gio.FILE_TYPE_REGULAR:
self.files_scanned += 1
if self.files_scanned % 100 == 0:
logger.debug("Scanned %s files", self.files_scanned)
base_name, ext = os.path.splitext(name)
ext = ext.lower()[1:]
file_type = rpdfile.file_type(ext)
if file_type is not None:
file_id = child.get_attribute_string(
gio.FILE_ATTRIBUTE_ID_FILE)
if file_id is not None:
# count how many files of each type are included
# e.g. photo, video
self.file_type_counter.add(file_type)
self.counter += 1
display_name = child.get_display_name()
size = child.get_size()
modification_time = child.get_modification_time()
path_name = path.get_path()
# look for thumbnail file for videos
if file_type == rpdfile.FILE_TYPE_VIDEO:
thm_full_name = get_video_THM_file(os.path.join(path_name, base_name))
else:
thm_full_name = None
# check if an audio file is associated with the photo or video
audio_file_full_name = get_audio_file(os.path.join(path_name, base_name))
scanned_file = rpdfile.get_rpdfile(ext,
name,
display_name,
path_name,
size,
modification_time,
thm_full_name,
audio_file_full_name,
self.pid,
file_id,
file_type)
self.files.append(scanned_file)
file_size_sum += size
if self.counter == self.batch_size:
# send batch of results
self.results_pipe.send((rpdmp.CONN_PARTIAL,
(file_size_sum,
self.file_type_counter,
self.pid,
self.files)))
self.files = []
self.counter = 0
return file_size_sum
def run(self):
"""start the actual scan."""
if self.use_re_ignored_paths and len(self.ignored_paths):
self.re_pattern = prefsrapid.check_and_compile_re(self.ignored_paths)
source = gio.File(self.path)
try:
if not self.ignore_this_path(self.path):
size = self._gio_scan(source, 0)
else:
size = None
except gio.Error, inst:
logger.error("Error while scanning %s: %s", self.path, inst)
size = None
if size is not None:
if self.counter > 0:
# send any remaining results
self.results_pipe.send((rpdmp.CONN_PARTIAL, (size,
self.file_type_counter,
self.pid,
self.files)))
self.results_pipe.send((rpdmp.CONN_COMPLETE, (size,
self.file_type_counter, self.pid)))
self.results_pipe.close()
def ignore_this_path(self, path):
"""
determines if the path should be ignored according to the preferences
chosen by the user
"""
if len(self.ignored_paths):
if self.use_re_ignored_paths and self.re_pattern:
# regular expressions are being used
if self.re_pattern.match(path):
return True
else:
# regular expressions are not being used
if path.endswith(tuple(self.ignored_paths)):
return True
return False
|
