-
Notifications
You must be signed in to change notification settings - Fork 276
/
post_processor.py
1355 lines (1144 loc) · 61.2 KB
/
post_processor.py
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# coding=utf-8
# Author: Nic Wolfe <nic@wolfeden.ca>
#
# This file is part of Medusa.
#
# Medusa 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 3 of the License, or
# (at your option) any later version.
#
# Medusa 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 Medusa. If not, see <http://www.gnu.org/licenses/>.
"""Post processor module."""
from __future__ import unicode_literals
import fnmatch
import os
import re
import stat
import subprocess
import sys
from builtins import object
from builtins import str
from collections import OrderedDict
import adba
from medusa import (
app,
db,
failed_history,
helpers,
history,
logger,
notifiers,
)
from medusa.common import (
ARCHIVED,
DOWNLOADED,
Quality,
SNATCHED,
SNATCHED_BEST,
SNATCHED_PROPER,
)
from medusa.helper.common import (
episode_num,
pretty_file_size,
remove_extension,
)
from medusa.helper.exceptions import (
EpisodeNotFoundException,
EpisodePostProcessingAbortException,
EpisodePostProcessingFailedException,
ShowDirectoryNotFoundException,
)
from medusa.helpers import is_subtitle, verify_freespace
from medusa.helpers.anidb import set_up_anidb_connection
from medusa.helpers.ffmpeg import FfMpeg, FfprobeBinaryException
from medusa.helpers.utils import generate
from medusa.name_parser.parser import (
InvalidNameException,
InvalidShowException,
NameParser,
)
from medusa.show import naming
from medusa.subtitles import from_code, from_ietf_code, get_subtitles_dir
import rarfile
from rarfile import Error as RarError, NeedFirstVolume
from six import viewitems
# Most common language tags from IETF
# https://datahub.io/core/language-codes#resource-ietf-language-tags
LANGUAGE_TAGS = {
'en-us': 'en-US',
'en-gb': 'en-GB',
'en-au': 'en-AU',
'pt-br': 'pt-BR',
'pt-pt': 'pt-PT',
'es-mx': 'es-MX',
'zh-cn': 'zh-CN',
'zh-tw': 'zh-TW',
}
class PostProcessor(object):
"""A class which will process a media file according to the post processing settings in the config."""
EXISTS_LARGER = 1
EXISTS_SAME = 2
EXISTS_SMALLER = 3
DOESNT_EXIST = 4
IGNORED_FILESTRINGS = ['.AppleDouble', '.DS_Store']
def __init__(self, file_path, nzb_name=None, process_method=None, is_priority=None):
"""
Create a new post processor with the given file path and optionally an NZB name.
file_path: The path to the file to be processed
nzb_name: The name of the NZB which resulted in this file being downloaded (optional)
"""
# absolute path to the folder that is being processed
self.folder_path = os.path.dirname(os.path.abspath(file_path))
# full path to file
self.file_path = file_path
# file name only
self.file_name = os.path.basename(file_path)
# relative path to the file that is being processed
self.rel_path = self._get_rel_path()
self.nzb_name = nzb_name
self.process_method = process_method or app.PROCESS_METHOD
self.in_history = False
self.release_group = None
self.release_name = None
self.is_proper = False
self.is_priority = is_priority
self._output = []
self.version = None
self.anidb_episode = None
self.manually_searched = False
self.info_hash = None
self.item_resources = OrderedDict([('file name', self.file_name),
('relative path', self.rel_path),
('nzb name', self.nzb_name)])
def log(self, message, level=logger.INFO):
"""
Wrap the internal logger which also keeps track of messages and saves them to a string for later.
:param message: The string to log (unicode)
:param level: The log level to use (optional)
"""
logger.log(message, level)
self._output.append(message)
@property
def output(self):
"""Return the concatenated log messages."""
return '\n'.join(self._output)
def _get_rel_path(self):
"""
Return the relative path to the file if possible, else the parent dir.
:return: relative path to file or parent dir to file
"""
if app.TV_DOWNLOAD_DIR:
try:
rel_path = os.path.relpath(self.file_path, app.TV_DOWNLOAD_DIR)
# check if we really found the relative path
if not rel_path.startswith('..'):
return rel_path
except ValueError:
pass
return self.file_path
def _compare_file_size(self, existing_file):
"""
Compare size to existing file.
:param existing_file: file to compare
:return:
DOESNT_EXIST if file doesn't exist
EXISTS_LARGER if existing file is larger
EXISTS_SMALLER if existing file is smaller
EXISTS_SAME if existing file is the same size
"""
new_size = os.path.getsize(self.file_path)
try:
old_size = os.path.getsize(existing_file)
except OSError:
self.log(u'New file: {}'.format(self.file_path))
self.log(u'New size: {}'.format(pretty_file_size(new_size)))
self.log(u"There is no existing file so there's no worries about replacing it", logger.DEBUG)
return self.DOESNT_EXIST
delta_size = new_size - old_size
self.log(u'Old file: {}'.format(existing_file))
self.log(u'New file: {}'.format(self.file_path))
self.log(u'Old size: {}'.format(pretty_file_size(old_size)))
self.log(u'New size: {}'.format(pretty_file_size(new_size)))
if not delta_size:
self.log(u'New file is the same size.')
return self.EXISTS_SAME
else:
self.log(u'New file is {size} {difference}'.format(
size=pretty_file_size(abs(delta_size)),
difference=u'smaller' if new_size < old_size else u'larger',
))
return self.EXISTS_LARGER if new_size < old_size else self.EXISTS_SMALLER
def list_associated_files(self, file_path, subfolders=False, subtitles_only=False, refine=False):
"""
For a given file path search for associated files and return their absolute paths.
:param file_path: path of the file to check for associated files
:param subfolders: also check subfolders while searching files
:param subtitles_only: list only associated subtitles
:param refine: refine the associated files with additional options
:return: A list containing all files which are associated to the given file
"""
files = self._search_files(file_path, subfolders=subfolders)
# file path to the video file that is being processed (without extension)
processed_file_name = os.path.splitext(os.path.basename(file_path))[0].lower()
processed_names = (processed_file_name,)
processed_names += tuple((_f for _f in (self._rar_basename(file_path, files),) if _f))
associated_files = set()
for found_file in files:
# Exclude the video file we are post-processing
if found_file == file_path:
continue
# Exclude non-subtitle files with the 'only subtitles' option
if subtitles_only and not is_subtitle(found_file):
continue
# Exclude .rar files
if re.search(r'(^.+\.(rar|r\d+)$)', found_file):
continue
file_name = os.path.basename(found_file).lower()
if file_name.startswith(processed_names):
associated_files.add(found_file)
if associated_files:
self.log(u'Found the following associated files for {0}: {1}'.format
(file_path, associated_files), logger.DEBUG)
if refine:
associated_files = self._refine_associated_files(associated_files)
else:
self.log(u'No associated files were found for {0}'.format(file_path), logger.DEBUG)
return list(associated_files)
def _refine_associated_files(self, files):
"""
Refine associated files with additional options.
:param files: set of associated files
:return: set containing the associated files left
"""
files_to_delete = set()
# "Delete associated files" setting
if app.MOVE_ASSOCIATED_FILES:
# "Keep associated file extensions" input box
if app.ALLOWED_EXTENSIONS:
allowed_extensions = app.ALLOWED_EXTENSIONS
for associated_file in files:
found_extension = helpers.get_extension(associated_file)
if found_extension and found_extension.lower() not in allowed_extensions:
files_to_delete.add(associated_file)
else:
files_to_delete = files
if files_to_delete:
self.log(u'Deleting following associated files: {0}'.format(files_to_delete), logger.DEBUG)
self._delete(list(files_to_delete))
return files - files_to_delete
@staticmethod
def _search_files(path, pattern='*', subfolders=False, basename_only=False, sort=False):
"""
Search for files in a given path.
:param path: path to file or folder (folder paths must end with slashes)
:param pattern: pattern used to match the files
:param subfolders: search for files in subfolders
:param basename_only: only match files with the same name
:param sort: return files sorted by size
:return: list with found files or empty list
"""
directory = os.path.dirname(path)
if basename_only:
if os.path.isfile(path):
new_pattern = os.path.splitext(os.path.basename(path))[0]
elif os.path.isdir(path):
new_pattern = os.path.split(directory)[1]
else:
logger.log(u'Basename match requires either a file or a directory. '
u'{name} is not allowed.'.format(name=path), logger.ERROR)
return []
if any(char in new_pattern for char in ['[', '?', '*']):
# Escaping is done by wrapping any of "*?[" between square brackets.
# Modified from: https://hg.python.org/cpython/file/tip/Lib/glob.py#l161
if isinstance(new_pattern, bytes):
new_pattern = re.compile(b'([*?[])').sub(br'[\1]', new_pattern)
else:
new_pattern = re.compile('([*?[])').sub(r'[\1]', new_pattern)
pattern = new_pattern + pattern
files = []
for root, _, filenames in os.walk(directory):
for filename in fnmatch.filter(filenames, pattern):
files.append(os.path.join(root, filename))
if not subfolders:
break
if sort:
files = sorted(files, key=os.path.getsize, reverse=True)
return files
@staticmethod
def _rar_basename(file_path, files):
"""Return the lowercase basename of the source rar archive if found."""
videofile = os.path.basename(file_path)
rars = (x for x in files if os.path.isfile(x) and rarfile.is_rarfile(x))
for rar in rars:
try:
content = rarfile.RarFile(rar).namelist()
except NeedFirstVolume:
continue
except RarError as error:
logger.log(u'An error occurred while reading the following RAR file: {name}. '
u'Error: {message}'.format(name=rar, message=error), logger.WARNING)
continue
if videofile in content:
return os.path.splitext(os.path.basename(rar))[0].lower() + '.'
def _delete(self, files, associated_files=False):
"""
Delete the file(s) and optionally all associated files.
:param files: path(s) to file(s) that should be deleted
:param associated_files: True to delete all files which differ only by extension, False to leave them
"""
gen_files = generate(files or [])
files = list(gen_files)
# also delete associated files, works only for 1 file
if associated_files and len(files) == 1:
files += self.list_associated_files(files[0], subfolders=True)
for filename in files:
if os.path.isfile(filename):
self.log(u'Deleting file: {0}'.format(filename), logger.DEBUG)
# check first the read-only attribute
file_attribute = os.stat(filename)[0]
if not file_attribute & stat.S_IWRITE:
# File is read-only, so make it writeable
self.log(u'Read only mode on file {0}. '
u'Will try to make it writeable'.format(filename),
logger.DEBUG)
try:
os.chmod(filename, stat.S_IWRITE)
except OSError as error:
self.log(
u'Cannot change permissions for {path}. '
u'Error: {msg}'.format(path=filename, msg=error),
logger.WARNING
)
os.remove(filename)
# do the library update for synoindex
notifiers.synoindex_notifier.deleteFile(filename)
@staticmethod
def rename_associated_file(new_path, new_basename, filepath):
"""Rename associated file using media basename.
:param new_path: full show folder path where the file will be moved|copied|linked to
:param new_basename: the media base filename (no extension) to use during the rename
:param filepath: full path of the associated file
:return: renamed full file path
"""
# file extension without leading dot
extension = helpers.get_extension(filepath)
# initially set current extension as new extension
new_extension = extension
# replace nfo with nfo-orig to avoid conflicts
if extension == 'nfo' and app.NFO_RENAME:
new_extension = 'nfo-orig'
elif is_subtitle(filepath):
split_path = filepath.rsplit('.', 2)
# len != 3 means we have a subtitle without language
if len(split_path) == 3:
sub_code = split_path[1]
code = sub_code.lower().replace('_', '-')
if from_code(code, unknown='') or from_ietf_code(code, unknown=''):
code = LANGUAGE_TAGS.get(code, code)
new_extension = code + '.' + extension
extension = sub_code + '.' + extension
# rename file with new basename
if new_basename:
new_filename = new_basename + '.' + new_extension
else:
# current file name including extension
new_filename = os.path.basename(filepath)
# if we're not renaming we still want to change the extension sometimes
if extension != new_extension:
new_filename = new_filename.replace(extension, new_extension)
new_filepath = os.path.join(new_path, new_filename)
if is_subtitle(new_filepath):
new_filepath = os.path.join(get_subtitles_dir(new_filepath), new_filename)
return new_filepath
def _combined_file_operation(self, file_path, new_path, new_basename, associated_files=False,
action=None, subtitles=False, subtitle_action=None):
"""
Perform a generic operation (move or copy) on a file.
Can rename the file as well as change its location, and optionally move associated files too.
:param file_path: The full path of the file to act on
:param new_path: full show folder path where the file will be moved|copied|linked to
:param new_basename: The base filename (no extension) to use during the action. Use None to keep the same name
:param associated_files: Boolean, whether we should copy similarly-named files too
:param action: function that takes an old path and new path and does an operation with them (move/copy/link)
:param subtitles: Boolean, whether we should process subtitles too
"""
if not action:
self.log(u'Must provide an action for the combined file operation', logger.ERROR)
return
other_files = []
if associated_files:
other_files += self.list_associated_files(file_path, refine=True)
if subtitles:
other_files += self.list_associated_files(file_path, subfolders=True, subtitles_only=True, refine=True)
# Remove possible duplicates
if associated_files:
other_files = list(set(other_files))
file_list = [file_path] + other_files
if not file_list:
self.log(u'There were no files associated with {0}, not moving anything'.format
(file_path), logger.DEBUG)
return
for cur_associated_file in file_list:
new_file_path = self.rename_associated_file(new_path, new_basename, cur_associated_file)
# If subtitle was downloaded from Medusa it can't be in the torrent folder, so we move it.
# Otherwise when torrent+data gets removed, the folder won't be deleted because of subtitle
if app.POSTPONE_IF_NO_SUBS and is_subtitle(cur_associated_file):
# subtitle_action = move
action = subtitle_action or action
action(cur_associated_file, new_file_path)
def post_process_action(self, file_path, new_path, new_basename, associated_files=False, subtitles=False):
"""
Run the given action on file and set proper permissions.
:param file_path: The full path of the file to act on
:param new_path: full show folder path where the file will be moved|copied|linked to
:param new_basename: The base filename (no extension) to use. Use None to keep the same name
:param associated_files: Boolean, whether we should run the action in similarly-named files too
:param subtitles: Boolean, whether we should process subtitles too
"""
def move(cur_file_path, new_file_path):
self.log(u'Moving file from {0} to {1} '.format(cur_file_path, new_file_path), logger.DEBUG)
try:
helpers.move_file(cur_file_path, new_file_path)
helpers.chmod_as_parent(new_file_path)
except (IOError, OSError) as e:
self.log(u'Unable to move file {0} to {1}: {2!r}'.format
(cur_file_path, new_file_path, e), logger.ERROR)
raise EpisodePostProcessingFailedException('Unable to move the files to their new home')
def copy(cur_file_path, new_file_path):
self.log(u'Copying file from {0} to {1}'.format(cur_file_path, new_file_path), logger.DEBUG)
try:
helpers.copy_file(cur_file_path, new_file_path)
helpers.chmod_as_parent(new_file_path)
except (IOError, OSError) as e:
self.log(u'Unable to copy file {0} to {1}: {2!r}'.format
(cur_file_path, new_file_path, e), logger.ERROR)
raise EpisodePostProcessingFailedException('Unable to copy the files to their new home')
def hardlink(cur_file_path, new_file_path):
self.log(u'Hard linking file from {0} to {1}'.format(cur_file_path, new_file_path), logger.DEBUG)
try:
helpers.hardlink_file(cur_file_path, new_file_path)
helpers.chmod_as_parent(new_file_path)
except (IOError, OSError) as e:
self.log(u'Unable to link file {0} to {1}: {2!r}'.format
(cur_file_path, new_file_path, e), logger.ERROR)
raise EpisodePostProcessingFailedException('Unable to hard link the files to their new home')
def symlink(cur_file_path, new_file_path):
self.log(u'Moving then symbolic linking file from {0} to {1}'.format
(cur_file_path, new_file_path), logger.DEBUG)
try:
helpers.move_and_symlink_file(cur_file_path, new_file_path)
helpers.chmod_as_parent(new_file_path)
except (IOError, OSError) as e:
self.log(u'Unable to link file {0} to {1}: {2!r}'.format
(cur_file_path, new_file_path, e), logger.ERROR)
raise EpisodePostProcessingFailedException('Unable to move and link the files to their new home')
def keeplink(cur_file_path, new_file_path):
self.log(u'Symbolic linking file from {0} to {1}'.format
(cur_file_path, new_file_path), logger.DEBUG)
try:
helpers.symlink(cur_file_path, new_file_path)
helpers.chmod_as_parent(new_file_path)
except (IOError, OSError) as e:
self.log(u'Unable to link file {0} to {1}: {2!r}'.format
(cur_file_path, new_file_path, e), logger.ERROR)
raise EpisodePostProcessingFailedException('Unable to move and link the files to their new home')
def reflink(cur_file_path, new_file_path):
self.log(u'Reflink file from {0} to {1}'.format(cur_file_path, new_basename), logger.DEBUG)
try:
helpers.reflink_file(cur_file_path, new_file_path)
helpers.chmod_as_parent(new_file_path)
except (IOError, OSError) as e:
self.log(u'Unable to reflink file {0} to {1}: {2!r}'.format
(cur_file_path, new_file_path, e), logger.ERROR)
raise EpisodePostProcessingFailedException('Unable to copy the files to their new home')
action = {'copy': copy, 'move': move, 'hardlink': hardlink, 'symlink': symlink, 'reflink': reflink, 'keeplink': keeplink}.get(self.process_method)
# Subtitle action should be move in case of hardlink|symlink|reflink as downloaded subtitle is not part of torrent
subtitle_action = {'copy': copy, 'move': move, 'hardlink': move, 'symlink': move, 'reflink': move}.get(self.process_method)
self._combined_file_operation(file_path, new_path, new_basename, associated_files=associated_files,
action=action, subtitles=subtitles, subtitle_action=subtitle_action)
@staticmethod
def _build_anidb_episode(connection, file_path):
"""
Look up anidb properties for an episode.
:param connection: anidb connection handler
:param file_path: file to check
:return: episode object
"""
ep = adba.Episode(connection, filePath=file_path,
paramsF=['quality', 'anidb_file_name', 'crc32'],
paramsA=['epno', 'english_name', 'short_name_list', 'other_name', 'synonym_list'])
return ep
def _add_to_anidb_mylist(self, file_path):
"""
Add an episode to anidb mylist.
:param file_path: file to add to mylist
"""
if set_up_anidb_connection():
if not self.anidb_episode: # seems like we could parse the name before, now lets build the anidb object
self.anidb_episode = self._build_anidb_episode(app.ADBA_CONNECTION, file_path)
self.log(u'Adding the file to the anidb mylist', logger.DEBUG)
try:
self.anidb_episode.add_to_mylist(state=1) # state = 1 sets the state of the file to "internal HDD"
except Exception as e:
self.log(u'Exception message: {0!r}'.format(e))
def _parse_info(self):
"""
For a given file try to find the show, season, epsiodes, version and quality.
:return: A (show, season, episodes, version, quality) tuple
"""
show = season = version = airdate = quality = None
episodes = []
for counter, (resource, name) in enumerate(self.item_resources.items()):
cur_show, cur_season, cur_episodes, cur_quality, cur_version = self._analyze_name(name)
if not cur_show:
continue
show = cur_show
if cur_season is not None:
season = cur_season
if cur_episodes:
episodes = cur_episodes
# we only get current version from anime
if cur_version is not None:
version = cur_version
# for air-by-date shows we need to look up the season/episode from database
if cur_season == -1 and show and cur_episodes:
self.log(u'Looks like this is an air-by-date or sports show, '
u'attempting to convert the date to season and episode', logger.DEBUG)
try:
airdate = episodes[0].toordinal()
except AttributeError:
self.log(u"Couldn't convert to a valid airdate: {0}".format(episodes[0]), logger.DEBUG)
continue
if counter < (len(self.item_resources) - 1):
if Quality.qualityStrings[cur_quality] == 'Unknown':
continue
quality = cur_quality
# We have all the information we need
self.log(u'Show information parsed from {0}'.format(resource), logger.DEBUG)
break
return show, season, episodes, quality, version, airdate
def _find_info(self):
series_obj, season, episodes, quality, version, airdate = self._parse_info()
# TODO: Move logic below to a single place -> NameParser
if airdate and series_obj:
# Ignore season 0 when searching for episode
# (conflict between special and regular episode, same air date)
main_db_con = db.DBConnection()
sql_result = main_db_con.select(
'SELECT season, episode '
'FROM tv_episodes '
'WHERE showid = ? '
'AND indexer = ? '
'AND airdate = ? '
'AND season != 0',
[series_obj.series_id, series_obj.indexer, airdate])
if sql_result:
season = int(sql_result[0]['season'])
episodes = [int(sql_result[0]['episode'])]
else:
# Found no result, trying with season 0
sql_result = main_db_con.select(
'SELECT season, episode '
'FROM tv_episodes '
'WHERE showid = ? '
'AND indexer = ? '
'AND airdate = ?',
[series_obj.series_id, series_obj.indexer, airdate])
if sql_result:
season = int(sql_result[0]['season'])
episodes = [int(sql_result[0]['episode'])]
else:
self.log(u'Unable to find episode with date {0} for show {1}, skipping'.format
(episodes[0], series_obj.indexerid), logger.DEBUG)
# we don't want to leave dates in the episode list
# if we couldn't convert them to real episode numbers
episodes = []
# If there's no season, we assume it's the first season
elif season is None and series_obj:
main_db_con = db.DBConnection()
numseasons_result = main_db_con.select(
'SELECT COUNT(DISTINCT season) as count '
'FROM tv_episodes '
'WHERE showid = ? '
'AND indexer = ? '
'AND season != 0',
[series_obj.series_id, series_obj.indexer])
if int(numseasons_result[0]['count']) == 1:
self.log(u"Episode doesn't have a season number, but this show appears "
u'to have only 1 season, setting season number to 1...', logger.DEBUG)
season = 1
return series_obj, season, episodes, quality, version
def _analyze_name(self, name):
"""
Take a name and try to figure out a show, season, episodes, version and quality from it.
:param name: A string which we want to analyze to determine show info from (unicode)
:return: A (show, season, episodes, version, quality) tuple
"""
to_return = (None, None, [], None, None)
if not name:
return to_return
logger.log(u'Analyzing name: {0}'.format(name), logger.DEBUG)
# parse the name to break it into show, season, episodes, quality and version
try:
parse_result = NameParser().parse(name, use_cache=False)
except (InvalidNameException, InvalidShowException) as error:
self.log(u'{0}'.format(error), logger.DEBUG)
return to_return
# if parsed result should be an anime, but doesn't have
# absolute numbering, parse again explicitly as anime
if parse_result.series and all([parse_result.series.is_anime,
not parse_result.is_anime]):
try:
parse_result.series.erase_cached_parse()
parse_result = NameParser(parse_method='anime').parse(name, use_cache=False)
except (InvalidNameException, InvalidShowException) as error:
self.log(u'{0}'.format(error), logger.DEBUG)
return to_return
if parse_result.series and all([parse_result.series.air_by_date or parse_result.series.is_sports,
parse_result.is_air_by_date]):
season = -1
episodes = [parse_result.air_date]
else:
season = parse_result.season_number
episodes = parse_result.episode_numbers
to_return = (parse_result.series, season, episodes, parse_result.quality, parse_result.version)
self._finalize(parse_result)
return to_return
def _finalize(self, parse_result):
"""
Store release name of result if it is complete and final.
:param parse_result: Result of parser
"""
self.release_group = parse_result.release_group
# remember whether it's a proper
self.is_proper = bool(parse_result.proper_tags)
# if the result is complete set release name
if parse_result.series_name and (
(parse_result.season_number is not None and parse_result.episode_numbers)
or parse_result.air_date
) and parse_result.release_group:
if not self.release_name:
self.release_name = remove_extension(os.path.basename(parse_result.original_name))
else:
logger.log(u"Parse result not sufficient (all following have to be set). Won't save release name",
logger.DEBUG)
logger.log(u'Parse result (series_name): {0}'.format(parse_result.series_name), logger.DEBUG)
logger.log(u'Parse result (season_number): {0}'.format(parse_result.season_number), logger.DEBUG)
logger.log(u'Parse result (episode_numbers): {0}'.format(parse_result.episode_numbers), logger.DEBUG)
logger.log(u'Parse result (ab_episode_numbers): {0}'.format(parse_result.ab_episode_numbers), logger.DEBUG)
logger.log(u'Parse result (air_date): {0}'.format(parse_result.air_date), logger.DEBUG)
logger.log(u'Parse result (release_group): {0}'.format(parse_result.release_group), logger.DEBUG)
def _get_ep_obj(self, series_obj, season, episodes):
"""
Retrieve the Episode object requested.
:param show: The show object belonging to the show we want to process
:param season: The season of the episode (int)
:param episodes: A list of episodes to find (list of ints)
:return: If the episode(s) can be found then a Episode object with the correct related eps will
be instantiated and returned. If the episode can't be found then None will be returned.
"""
root_ep = None
for cur_episode in episodes:
self.log(u'Retrieving episode object for {0} {1}'.format
(series_obj.name, episode_num(season, cur_episode)), logger.DEBUG)
# now that we've figured out which episode this file is just load it manually
try:
cur_ep = series_obj.get_episode(season, cur_episode)
if not cur_ep:
raise EpisodeNotFoundException()
except EpisodeNotFoundException as e:
raise EpisodePostProcessingFailedException(u'Unable to create episode: {0!r}'.format(e))
# associate all the episodes together under a single root episode
if root_ep is None:
root_ep = cur_ep
root_ep.related_episodes = []
elif cur_ep not in root_ep.related_episodes:
root_ep.related_episodes.append(cur_ep)
return root_ep
# def _quality_from_status(self, ep_obj):
# """
# Determine the quality of the file that is being post processed with its status.
#
# :param ep_obj: episode object.
# :return: A quality value found in common.Quality
# """
#
# if ep_obj.status in (common.SNATCHED, common.SNATCHED_PROPER, common.SNATCHED_BEST):
# if ep_obj.quality != common.Quality.UNKNOWN:
# self.log(u'The snatched status has a quality in it, using that: {0}'.format
# (common.Quality.qualityStrings[ep_obj.quality]), logger.DEBUG)
# return ep_obj.quality
#
# return common.UNKNOWN
def _get_quality(self, ep_obj):
"""
Determine the quality of the file that is being post processed with alternative methods.
:param ep_obj: The Episode object related to the file we are post processing
:return: A quality value found in common.Quality
"""
for resource_name, cur_name in viewitems(self.item_resources):
# Skip names that are falsey
if not cur_name:
continue
ep_quality = Quality.name_quality(cur_name, ep_obj.series.is_anime, extend=False)
self.log(u"Looking up quality for '{0}', got {1}".format
(cur_name, Quality.qualityStrings[ep_quality]), logger.DEBUG)
if ep_quality != Quality.UNKNOWN:
self.log(u"Looks like {0} '{1}' has quality {2}, using that".format
(resource_name, cur_name, Quality.qualityStrings[ep_quality]), logger.DEBUG)
return ep_quality
# Try using other methods to get the file quality
ep_quality = Quality.name_quality(self.file_path, ep_obj.series.is_anime)
self.log(u"Trying other methods to get quality for '{0}', got {1}".format
(self.file_name, Quality.qualityStrings[ep_quality]), logger.DEBUG)
if ep_quality != Quality.UNKNOWN:
self.log(u"Looks like '{0}' has quality {1}, using that".format
(self.file_name, Quality.qualityStrings[ep_quality]), logger.DEBUG)
return ep_quality
return ep_quality
def _priority_from_history(self, series_obj, season, episodes, quality):
"""Evaluate if the file should be marked as priority."""
main_db_con = db.DBConnection()
snatched_statuses = [SNATCHED, SNATCHED_PROPER, SNATCHED_BEST]
for episode in episodes:
# First: check if the episode status is snatched
tv_episodes_result = main_db_con.select(
'SELECT quality, manually_searched '
'FROM tv_episodes '
'WHERE indexer = ? '
'AND showid = ? '
'AND season = ? '
'AND episode = ? '
'AND status IN (?, ?, ?) ',
[series_obj.indexer, series_obj.series_id,
season, episode] + snatched_statuses
)
if tv_episodes_result and tv_episodes_result[0]['quality'] == quality:
# Check if the snatch is a manual snatch
if tv_episodes_result[0]['manually_searched'] == 1:
self.manually_searched = True
# Second: get the quality of the last snatched epsiode
# and compare it to the quality we are post-processing
history_result = main_db_con.select(
'SELECT quality, info_hash '
'FROM history '
'WHERE indexer_id = ? '
'AND showid = ? '
'AND season = ? '
'AND episode = ? '
'AND action IN (?, ?, ?) '
'ORDER BY date DESC',
[series_obj.indexer, series_obj.series_id,
season, episode] + snatched_statuses
)
if history_result and history_result[0]['quality'] == quality:
# Third: make sure the file we are post-processing hasn't been
# previously processed, as we wouldn't want it in that case
# Get info hash so we can move torrent if setting is enabled
self.info_hash = history_result[0]['info_hash'] or None
download_result = main_db_con.select(
'SELECT resource '
'FROM history '
'WHERE indexer_id = ? '
'AND showid = ? '
'AND season = ? '
'AND episode = ? '
'AND quality = ? '
'AND action = ? '
'ORDER BY date DESC',
[series_obj.indexer, series_obj.series_id,
season, episode, quality, DOWNLOADED]
)
if download_result:
download_name = os.path.basename(download_result[0]['resource'])
# If the file name we are processing differs from the file
# that was previously processed, we want this file
if self.file_name != download_name:
self.in_history = True
return
else:
# There aren't any other files processed before for this
# episode and quality, we can safely say we want this file
self.in_history = True
return
def _is_priority(self, old_ep_quality, new_ep_quality):
"""
Determine if the episode is a priority download or not (if it is expected).
Episodes which are expected (snatched) are priority, others are not.
:param old_ep_quality: The old quality of the episode that is being processed
:param new_ep_quality: The new quality of the episode that is being processed
:return: True if the episode is priority, False otherwise.
"""
level = logger.DEBUG
self.log(u'Snatch in history: {0}'.format(self.in_history), level)
self.log(u'Manually snatched: {0}'.format(self.manually_searched), level)
self.log(u'Info hash: {0}'.format(self.info_hash), level)
self.log(u'Resource name: {0}'.format(self.nzb_name), level)
self.log(u'Current quality: {0}'.format(Quality.qualityStrings[old_ep_quality]), level)
self.log(u'New quality: {0}'.format(Quality.qualityStrings[new_ep_quality]), level)
self.log(u'Proper: {0}'.format(self.is_proper), level)
# If in_history is True it must be a priority download
return any([self.in_history, self.is_priority, self.manually_searched])
@staticmethod
def _should_process(current_quality, new_quality, allowed, preferred):
"""
Determine if a quality should be processed according to the quality system.
This method is used only for replace existing files
Despite quality system rules (should_search method), in should_process method:
- New higher Allowed replaces current Allowed (overrrides rule where Allowed is final quality)
- New higher Preferred replaces current Preferred (overrides rule where Preffered is final quality)
:param current_quality: The current quality of the episode that is being processed
:param new_quality: The new quality of the episode that is being processed
:param allowed: Qualities that are allowed
:param preferred: Qualities that are preferred
:return: Tuple with Boolean if the quality should be processed and String with reason if should process or not
"""
if new_quality in preferred:
if current_quality in preferred:
if new_quality > current_quality:
return True, 'New quality is higher than current Preferred. Accepting quality'
elif new_quality < current_quality:
return False, 'New quality is lower than current Preferred. Ignoring quality'
else:
return False, 'New quality is equal than current Preferred. Ignoring quality'
return True, 'New quality is Preferred'
elif new_quality in allowed:
if current_quality in preferred:
return False, 'Current quality is Allowed but we already have a current Preferred. Ignoring quality'
elif current_quality not in allowed:
return True, "New quality is Allowed and we don't have a current Preferred. Accepting quality"
elif new_quality > current_quality:
return True, 'New quality is higher than current Allowed. Accepting quality'
elif new_quality < current_quality:
return False, 'New quality is lower than current Allowed. Ignoring quality'
else:
return False, 'New quality is equal to current Allowed. Ignoring quality'
else:
return False, 'New quality is not in Allowed|Preferred. Ignoring quality'
def _run_extra_scripts(self, ep_obj):
"""
Execute any extra scripts defined in the config.
:param ep_obj: The object to use when calling the extra script
"""
if not app.EXTRA_SCRIPTS:
return
ep_location = ep_obj.location
file_path = self.file_path
indexer_id = str(ep_obj.series.indexerid)
season = str(ep_obj.season)
episode = str(ep_obj.episode)
airdate = str(ep_obj.airdate)
for script_path in app.EXTRA_SCRIPTS:
if not os.path.isfile(script_path):
self.log(u'Extra script {0} is not a file.'.format(script_path), logger.WARNING)
continue
if not script_path.endswith('.py'):
self.log(u'Extra script {0} is not a Python file.'.format(script_path), logger.WARNING)
continue
self.log(u'Running extra script: {0}'.format(script_path), logger.INFO)
script_cmd = [sys.executable, script_path, ep_location, file_path, indexer_id, season, episode, airdate]