summaryrefslogtreecommitdiff
path: root/lib/python2.7/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python2.7/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py')
-rw-r--r--lib/python2.7/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py319
1 files changed, 0 insertions, 319 deletions
diff --git a/lib/python2.7/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py b/lib/python2.7/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py
deleted file mode 100644
index 90552b1..0000000
--- a/lib/python2.7/site-packages/django/contrib/staticfiles/management/commands/collectstatic.py
+++ /dev/null
@@ -1,319 +0,0 @@
-from __future__ import unicode_literals
-
-import os
-import sys
-from optparse import make_option
-
-from django.core.files.storage import FileSystemStorage
-from django.core.management.base import CommandError, NoArgsCommand
-from django.utils.encoding import smart_text
-from django.utils.datastructures import SortedDict
-from django.utils.functional import LazyObject
-from django.utils.six.moves import input
-
-from django.contrib.staticfiles import finders, storage
-
-
-class Command(NoArgsCommand):
- """
- Command that allows to copy or symlink static files from different
- locations to the settings.STATIC_ROOT.
- """
- option_list = NoArgsCommand.option_list + (
- make_option('--noinput',
- action='store_false', dest='interactive', default=True,
- help="Do NOT prompt the user for input of any kind."),
- make_option('--no-post-process',
- action='store_false', dest='post_process', default=True,
- help="Do NOT post process collected files."),
- make_option('-i', '--ignore', action='append', default=[],
- dest='ignore_patterns', metavar='PATTERN',
- help="Ignore files or directories matching this glob-style "
- "pattern. Use multiple times to ignore more."),
- make_option('-n', '--dry-run',
- action='store_true', dest='dry_run', default=False,
- help="Do everything except modify the filesystem."),
- make_option('-c', '--clear',
- action='store_true', dest='clear', default=False,
- help="Clear the existing files using the storage "
- "before trying to copy or link the original file."),
- make_option('-l', '--link',
- action='store_true', dest='link', default=False,
- help="Create a symbolic link to each file instead of copying."),
- make_option('--no-default-ignore', action='store_false',
- dest='use_default_ignore_patterns', default=True,
- help="Don't ignore the common private glob-style patterns 'CVS', "
- "'.*' and '*~'."),
- )
- help = "Collect static files in a single location."
- requires_model_validation = False
-
- def __init__(self, *args, **kwargs):
- super(NoArgsCommand, self).__init__(*args, **kwargs)
- self.copied_files = []
- self.symlinked_files = []
- self.unmodified_files = []
- self.post_processed_files = []
- self.storage = storage.staticfiles_storage
- try:
- self.storage.path('')
- except NotImplementedError:
- self.local = False
- else:
- self.local = True
-
- def set_options(self, **options):
- """
- Set instance variables based on an options dict
- """
- self.interactive = options['interactive']
- self.verbosity = int(options.get('verbosity', 1))
- self.symlink = options['link']
- self.clear = options['clear']
- self.dry_run = options['dry_run']
- ignore_patterns = options['ignore_patterns']
- if options['use_default_ignore_patterns']:
- ignore_patterns += ['CVS', '.*', '*~']
- self.ignore_patterns = list(set(ignore_patterns))
- self.post_process = options['post_process']
-
- def collect(self):
- """
- Perform the bulk of the work of collectstatic.
-
- Split off from handle_noargs() to facilitate testing.
- """
- if self.symlink:
- if sys.platform == 'win32':
- raise CommandError("Symlinking is not supported by this "
- "platform (%s)." % sys.platform)
- if not self.local:
- raise CommandError("Can't symlink to a remote destination.")
-
- if self.clear:
- self.clear_dir('')
-
- if self.symlink:
- handler = self.link_file
- else:
- handler = self.copy_file
-
- found_files = SortedDict()
- for finder in finders.get_finders():
- for path, storage in finder.list(self.ignore_patterns):
- # Prefix the relative path if the source storage contains it
- if getattr(storage, 'prefix', None):
- prefixed_path = os.path.join(storage.prefix, path)
- else:
- prefixed_path = path
-
- if prefixed_path not in found_files:
- found_files[prefixed_path] = (storage, path)
- handler(path, prefixed_path, storage)
-
- # Here we check if the storage backend has a post_process
- # method and pass it the list of modified files.
- if self.post_process and hasattr(self.storage, 'post_process'):
- processor = self.storage.post_process(found_files,
- dry_run=self.dry_run)
- for original_path, processed_path, processed in processor:
- if isinstance(processed, Exception):
- self.stderr.write("Post-processing '%s' failed!" % original_path)
- # Add a blank line before the traceback, otherwise it's
- # too easy to miss the relevant part of the error message.
- self.stderr.write("")
- raise processed
- if processed:
- self.log("Post-processed '%s' as '%s'" %
- (original_path, processed_path), level=1)
- self.post_processed_files.append(original_path)
- else:
- self.log("Skipped post-processing '%s'" % original_path)
-
- return {
- 'modified': self.copied_files + self.symlinked_files,
- 'unmodified': self.unmodified_files,
- 'post_processed': self.post_processed_files,
- }
-
- def handle_noargs(self, **options):
- self.set_options(**options)
-
- message = ['\n']
- if self.dry_run:
- message.append(
- 'You have activated the --dry-run option so no files will be modified.\n\n'
- )
-
- message.append(
- 'You have requested to collect static files at the destination\n'
- 'location as specified in your settings'
- )
-
- if self.is_local_storage() and self.storage.location:
- destination_path = self.storage.location
- message.append(':\n\n %s\n\n' % destination_path)
- else:
- destination_path = None
- message.append('.\n\n')
-
- if self.clear:
- message.append('This will DELETE EXISTING FILES!\n')
- else:
- message.append('This will overwrite existing files!\n')
-
- message.append(
- 'Are you sure you want to do this?\n\n'
- "Type 'yes' to continue, or 'no' to cancel: "
- )
-
- if self.interactive and input(''.join(message)) != 'yes':
- raise CommandError("Collecting static files cancelled.")
-
- collected = self.collect()
- modified_count = len(collected['modified'])
- unmodified_count = len(collected['unmodified'])
- post_processed_count = len(collected['post_processed'])
-
- if self.verbosity >= 1:
- template = ("\n%(modified_count)s %(identifier)s %(action)s"
- "%(destination)s%(unmodified)s%(post_processed)s.\n")
- summary = template % {
- 'modified_count': modified_count,
- 'identifier': 'static file' + ('' if modified_count == 1 else 's'),
- 'action': 'symlinked' if self.symlink else 'copied',
- 'destination': (" to '%s'" % destination_path if destination_path else ''),
- 'unmodified': (', %s unmodified' % unmodified_count if collected['unmodified'] else ''),
- 'post_processed': (collected['post_processed'] and
- ', %s post-processed'
- % post_processed_count or ''),
- }
- self.stdout.write(summary)
-
- def log(self, msg, level=2):
- """
- Small log helper
- """
- if self.verbosity >= level:
- self.stdout.write(msg)
-
- def is_local_storage(self):
- if issubclass(self.storage.__class__, LazyObject):
- storage = self.storage._wrapped
- else:
- storage = self.storage
- return isinstance(storage, FileSystemStorage)
-
- def clear_dir(self, path):
- """
- Deletes the given relative path using the destination storage backend.
- """
- dirs, files = self.storage.listdir(path)
- for f in files:
- fpath = os.path.join(path, f)
- if self.dry_run:
- self.log("Pretending to delete '%s'" %
- smart_text(fpath), level=1)
- else:
- self.log("Deleting '%s'" % smart_text(fpath), level=1)
- self.storage.delete(fpath)
- for d in dirs:
- self.clear_dir(os.path.join(path, d))
-
- def delete_file(self, path, prefixed_path, source_storage):
- """
- Checks if the target file should be deleted if it already exists
- """
- if self.storage.exists(prefixed_path):
- try:
- # When was the target file modified last time?
- target_last_modified = \
- self.storage.modified_time(prefixed_path)
- except (OSError, NotImplementedError, AttributeError):
- # The storage doesn't support ``modified_time`` or failed
- pass
- else:
- try:
- # When was the source file modified last time?
- source_last_modified = source_storage.modified_time(path)
- except (OSError, NotImplementedError, AttributeError):
- pass
- else:
- # The full path of the target file
- if self.local:
- full_path = self.storage.path(prefixed_path)
- else:
- full_path = None
- # Skip the file if the source file is younger
- # Avoid sub-second precision (see #14665, #19540)
- if (target_last_modified.replace(microsecond=0)
- >= source_last_modified.replace(microsecond=0)):
- if not ((self.symlink and full_path
- and not os.path.islink(full_path)) or
- (not self.symlink and full_path
- and os.path.islink(full_path))):
- if prefixed_path not in self.unmodified_files:
- self.unmodified_files.append(prefixed_path)
- self.log("Skipping '%s' (not modified)" % path)
- return False
- # Then delete the existing file if really needed
- if self.dry_run:
- self.log("Pretending to delete '%s'" % path)
- else:
- self.log("Deleting '%s'" % path)
- self.storage.delete(prefixed_path)
- return True
-
- def link_file(self, path, prefixed_path, source_storage):
- """
- Attempt to link ``path``
- """
- # Skip this file if it was already copied earlier
- if prefixed_path in self.symlinked_files:
- return self.log("Skipping '%s' (already linked earlier)" % path)
- # Delete the target file if needed or break
- if not self.delete_file(path, prefixed_path, source_storage):
- return
- # The full path of the source file
- source_path = source_storage.path(path)
- # Finally link the file
- if self.dry_run:
- self.log("Pretending to link '%s'" % source_path, level=1)
- else:
- self.log("Linking '%s'" % source_path, level=1)
- full_path = self.storage.path(prefixed_path)
- try:
- os.makedirs(os.path.dirname(full_path))
- except OSError:
- pass
- os.symlink(source_path, full_path)
- if prefixed_path not in self.symlinked_files:
- self.symlinked_files.append(prefixed_path)
-
- def copy_file(self, path, prefixed_path, source_storage):
- """
- Attempt to copy ``path`` with storage
- """
- # Skip this file if it was already copied earlier
- if prefixed_path in self.copied_files:
- return self.log("Skipping '%s' (already copied earlier)" % path)
- # Delete the target file if needed or break
- if not self.delete_file(path, prefixed_path, source_storage):
- return
- # The full path of the source file
- source_path = source_storage.path(path)
- # Finally start copying
- if self.dry_run:
- self.log("Pretending to copy '%s'" % source_path, level=1)
- else:
- self.log("Copying '%s'" % source_path, level=1)
- if self.local:
- full_path = self.storage.path(prefixed_path)
- try:
- os.makedirs(os.path.dirname(full_path))
- except OSError:
- pass
- with source_storage.open(path) as source_file:
- self.storage.save(prefixed_path, source_file)
- if not prefixed_path in self.copied_files:
- self.copied_files.append(prefixed_path)