Working in Progress for #22

Author: chinyeungli

src/attributecode/cmd.py

@@ -40,6 +40,7 @@
 from attributecode.attrib import generate_and_save as generate_attribution_doc
 from attributecode.gen import generate as generate_about_files
 from attributecode.model import collect_inventory
+from attributecode.model import copy_redist_src
 from attributecode.model import write_output
 from attributecode.util import extract_zip
 from attributecode.util import filter_errors
@@ -360,6 +361,61 @@ def attrib(location, output, template, vartext, quiet, verbose):
     sys.exit(errors_count)
 
 
+######################################################################
+# collect_redist_src subcommand
+######################################################################
+
+@about.command(cls=AboutCommand,
+    short_help='Collect redistributable sources.')
+
+@click.argument('location',
+    required=True,
+    metavar='LOCATION',
+    type=click.Path(
+        exists=True, file_okay=True, dir_okay=True, readable=True, resolve_path=True))
+
+@click.argument('output',
+    required=True,
+    metavar='OUTPUT',
+    type=click.Path(exists=True, file_okay=False, writable=True, resolve_path=True))
+
+@click.option('-q', '--quiet',
+    is_flag=True,
+    help='Do not print error or warning messages.')
+
+@click.option('--verbose',
+    is_flag=True,
+    help='Show all error and warning messages.')
+
+@click.help_option('-h', '--help')
+
+def collect_redist_src(location, output, quiet, verbose):
+    """
+Collect sources that have 'redistribute' flagged to the output location.
+
+LOCATION: Path to a file or directory containing .ABOUT files.
+
+OUTPUT: Path to a directory where sources will be copied to.
+    """
+    if not quiet:
+        print_version()
+        click.echo('Collecting inventory from ABOUT files...')
+
+    if location.lower().endswith('.zip'):
+        # accept zipped ABOUT files as input
+        location = extract_zip(location)
+
+    errors, abouts = collect_inventory(location)
+    copy_errors = copy_redist_src(abouts, location, output)
+
+    errors.extend(copy_errors)
+    errors_count = report_errors(errors, quiet, verbose, log_file_loc=output + '-error.log')
+    if not quiet:
+        msg = 'Inventory collected in {output}.'.format(**locals())
+        click.echo(msg)
+    sys.exit(errors_count)
+
+
 ######################################################################
 # check subcommand
 ######################################################################

src/attributecode/model.py

@@ -63,6 +63,7 @@
 from attributecode.util import add_unc
 from attributecode.util import boolean_fields
 from attributecode.util import copy_license_notice_files
+from attributecode.util import copy_file
 from attributecode.util import csv
 from attributecode.util import file_fields
 from attributecode.util import filter_errors
@@ -867,7 +868,7 @@ def hydrate(self, fields):
                 # this is a special attribute, skip entirely
                 continue
 
-            # A field that has been alredy processed ... and has a value
+            # A field that has been already processed ... and has a value
             previous_value = seen_fields.get(name)
             if previous_value:
                 if value != previous_value:
@@ -1268,6 +1269,25 @@ def get_field_names(abouts):
     return fields
 
 
+def copy_redist_src(abouts, location, output):
+    """
+    Given a list of About objects, copy the referenced source (file or directory)
+    to the output location if the 'redistribute' field is set to True. 
+    """
+    errors = []
+    for about in abouts:
+        if about.redistribute.value:
+            for e in about.errors:
+                if 'Field about_resource' in e.message and 'not found' in e.message:
+                    msg = e.message + u' and cannot be copied.'
+                    errors.append(Error(CRITICAL, msg))
+                    continue
+            for k in about.about_resource.value:
+                from_path = about.about_resource.value.get(k)
+                copy_file(from_path, output)
+    return errors
+
+
 def about_object_to_list_of_dictionary(abouts):
     """
     Convert About objects to a list of dictionaries

src/attributecode/util.py

@@ -466,26 +466,39 @@ def copy_license_notice_files(fields, base_dir, reference_dir, afp):
                 from_lic_path = posixpath.join(to_posix(reference_dir), copy_file_name)
                 about_file_dir = os.path.dirname(to_posix(afp)).lstrip('/')
                 to_lic_path = posixpath.join(to_posix(base_dir), about_file_dir)
-    
-                if on_windows:
-                    from_lic_path = add_unc(from_lic_path)
-                    to_lic_path = add_unc(to_lic_path)
-    
-                # Strip the white spaces
-                from_lic_path = from_lic_path.strip()
-                to_lic_path = to_lic_path.strip()
-    
-                # Errors will be captured when doing the validation
-                if not posixpath.exists(from_lic_path):
-                    continue
-    
-                if not posixpath.exists(to_lic_path):
-                    os.makedirs(to_lic_path)
-                try:
-                    shutil.copy2(from_lic_path, to_lic_path)
-                except Exception as e:
-                    print(repr(e))
-                    print('Cannot copy file at %(from_lic_path)r.' % locals())
+
+                copy_file(from_lic_path, to_lic_path)
+
+
+def copy_file(from_path, to_path):
+    # Return if the from_path is empty or None.
+    if not from_path:
+        return
+
+    if on_windows:
+        from_path = add_unc(from_path)
+        to_path = add_unc(to_path)
+
+    # Strip the white spaces
+    from_path = from_path.strip()
+    to_path = to_path.strip()
+
+    # Errors will be captured when doing the validation
+    if not posixpath.exists(from_path):
+        return
+
+    if not posixpath.exists(to_path):
+        os.makedirs(to_path)
+    try:
+        if os.path.isdir(from_path):
+            print("#############################")
+            from distutils.dir_util import copy_tree
+            copy_tree(from_path, to_path)
+        else:
+            shutil.copy2(from_path, to_path)
+    except Exception as e:
+        print(repr(e))
+        print('Cannot copy file at %(from_path)r.' % locals())
 
 
 # FIXME: we should use a license object instead