Merge branch 'release-v1.0.0' into develop

Author: pombredanne

SPEC

@@ -36,7 +36,7 @@
 
 from collections import namedtuple
 from os import makedirs
-from os.path import exists, dirname, join, abspath, isdir, normpath, basename
+from os.path import exists, dirname, join, abspath, isdir, normpath, basename, expanduser
 
 import about
 
@@ -237,7 +237,7 @@ def verify_files_existence(self, input_list, project_dir, file_in_project):
         # Get all the dictionary keys
         column_keys = input_list[0].keys()
 
-        # Get all the keys that ends with _file except for the 'about_file
+        # Get all the keys that ends with _file except for the 'about_file'
         file_keys = []
         for key in column_keys:
             if key.endswith('_file') and key != 'about_file':
@@ -289,6 +289,19 @@ def request_license_data(self, url, username, api_key, license_key):
             'format': 'json'
         }
 
+        # Check is the provided api_url valid or not.
+        try:
+            request = urllib2.Request(url)
+            response = urllib2.urlopen(request)
+            response_content = response.read()
+        except urllib2.HTTPError as http_e:
+            if http_e.code == 404:
+                error_msg = ("URL not reachable. Invalid '--api_url'."
+                                 " LICENSE generation is skipped.")
+                print("\n" + error_msg + "\n")
+                self.extract_dje_license_error = True
+                self.errors.append(Error('--api_url', url, error_msg))
+
         url = url.rstrip('/')
         encoded_payload = urllib.urlencode(payload)
         full_url = '%(url)s/%(license_key)s/?%(encoded_payload)s' % locals()
@@ -382,31 +395,16 @@ def get_dje_license_list(self, gen_location, input_list, gen_license, dje_licens
                     license_file_list = []
                     file_location = line['about_file']
                     about_parent_dir = dirname(file_location)
-                    if '\n' in line['license_text_file']:
-                        file_value = line['license_text_file'].split('\n')
-                    else:
-                        file_value = [line['license_text_file']]
-                    for license_text_file in file_value:
-                        license_file_list.append(normpath(gen_location.rpartition('/')[0] + join(about_parent_dir, license_text_file)))
-                    for license_file in license_file_list:
-                        if not _exists(license_file):
-                            self.errors.append(Error('license_text_file', license_file, "The 'license_text_file' does not exist."))
+                    license_text_file = line['license_text_file']
+                    license_file = normpath(gen_location.rpartition('/')[0] + join(about_parent_dir, license_text_file))
+                    if not _exists(license_file):
+                        self.errors.append(Error('license_text_file', license_file, "The 'license_text_file' does not exist."))
                 else:
                     if gen_license:
                         if line['dje_license']:
                             license_output_list.append(self.gen_license_list(line))
-                            license_names = []
-                            if '\n' in line['dje_license_name']:
-                                license_names = line['dje_license_name'].split('\n ')
-                            else:
-                                license_names = [line['dje_license_name']]
-                            for lic_name in license_names:
-                                try:
-                                    if line['license_text_file']:
-                                        line['license_text_file'] += '\n '
-                                    line['license_text_file'] += dje_license_dict[lic_name][0] + '.LICENSE'
-                                except:
-                                    line['license_text_file'] = dje_license_dict[lic_name][0] + '.LICENSE'
+                            lic_name = line['dje_license_name']
+                            line['license_text_file'] = dje_license_dict[lic_name][0] + '.LICENSE'
                         else:
                             self.warnings.append(Warn('dje_license', '',
                                                       "Missing 'dje_license' for " + line['about_file']))
@@ -417,18 +415,9 @@ def get_dje_license_list(self, gen_location, input_list, gen_license, dje_licens
                 if gen_license:
                     if line['dje_license']:
                         license_output_list.append(self.gen_license_list(line))
-                        license_names = []
-                        if '\n' in line['dje_license_name']:
-                            license_names = line['dje_license_name'].split('\n ')
-                        else:
-                            license_names = [line['dje_license_name']]
-
-                        for lic_name in license_names:
-                            if 'license_text_file' in line:
-                                line['license_text_file'] += '\n '
-                            license_name = dje_license_dict[lic_name][0]
-                            license_text_file = license_name + '.LICENSE'
-                            line['license_text_file'] = license_text_file
+                        lic_name = line['dje_license_name']
+                        if lic_name:
+                            line['license_text_file'] = dje_license_dict[lic_name][0] + '.LICENSE'
                     else:
                         self.warnings.append(Warn('dje_license', '',
                                                   "Missing 'dje_license' for " + line['about_file']))
@@ -440,32 +429,25 @@ def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, ap
         for line in input_list:
             try:
                 if line['dje_license']:
-                    license_list = []
                     if '\n' in line['dje_license']:
-                        license_list = line['dje_license'].split('\n')
+                        line['dje_license_name'] = ""
+                        self.errors.append(Error('dje_license',
+                                                 line['dje_license'],
+                                                 "No multiple licenses or newline character are accepted."))
+                        continue
+                    lic = line['dje_license']
+                    if not lic in license_dict:
+                        detail_list = []
+                        detail = self.get_license_details_from_api(api_url, api_username, api_key, lic)
+                        license_dict[lic] = detail[0]
+                        line['dje_license_name'] = detail[0]
+                        dje_key = detail[1]
+                        license_context = detail [2]
+                        detail_list.append(dje_key)
+                        detail_list.append(license_context)
+                        key_text_dict[detail[0]] = detail_list
                     else:
-                        license_list = [line['dje_license']]
-                    for lic in license_list:
-                        if not lic in license_dict:
-                            detail_list = []
-                            detail = self.get_license_details_from_api(api_url, api_username, api_key, lic)
-                            license_dict[lic] = detail[0]
-                            try:
-                                if line['dje_license_name']:
-                                    line['dje_license_name'] += "\n " + detail[0]
-                            except:
-                                line['dje_license_name'] = detail[0]
-                            dje_key = detail[1]
-                            license_context = detail [2]
-                            detail_list.append(dje_key)
-                            detail_list.append(license_context)
-                            key_text_dict[detail[0]] = detail_list
-                        else:
-                            try:
-                                if line['dje_license_name']:
-                                    line['dje_license_name'] += "\n " + license_dict[lic]
-                            except:
-                                line['dje_license_name'] = license_dict[lic]
+                        line['dje_license_name'] = license_dict[lic]
             except Exception:
                 err = Warn('dje_license', '',
                            'Missing "dje_license" for ' + line['about_file'])
@@ -475,14 +457,10 @@ def pre_process_and_dje_license_dict(self, input_list, api_url, api_username, ap
     def process_dje_licenses(self, dje_license_list, dje_license_dict, output_path):
         license_list_context = []
         for gen_path, license_name in dje_license_list:
-            licenses = []
-            if '\n' in license_name:
-                licenses = license_name.split('\n ')
-            else:
-                licenses = [license_name]
+            lic = license_name
             if gen_path.startswith('/'):
                 gen_path = gen_path.partition('/')[2]
-            for lic in licenses:
+            if lic:
                 license_key = dje_license_dict[lic][0]
                 gen_license_path = join(output_path, gen_path, license_key) + '.LICENSE'
                 if not _exists(gen_license_path) and not self.extract_dje_license_error:
@@ -566,6 +544,12 @@ def update_about_resource(self, line, about_file_exist):
                     about_resource = line['about_file']
                     if about_resource.endswith('/'):
                         line['about_resource'] = '.'
+            else: # 'about_resource' key present with no value
+                about_resource = line['about_file']
+                if about_resource.endswith('/'):
+                    line['about_resource'] = '.'
+                else:
+                    line['about_resource'] = basename(about_resource)
         except:
             # Add the 'about_resource' field
             about_resource = line['about_file']
@@ -724,11 +708,17 @@ def main(parser, options, args):
             print('Invalid action: should be 0, 1, 2 or 3')
             sys.exit(errno.EINVAL)
 
-    if copy_files_path and not _exists(copy_files_path):
+    if copy_files_path:
+        # code to handle tilde character
+        copy_files_path = os.path.abspath(expanduser(copy_files_path))
+        if not _exists(copy_files_path):
             print("The project path does not exist.")
             sys.exit(errno.EINVAL)
 
-    if license_text_path and not _exists(license_text_path):
+    if license_text_path:
+        # code to handle tilde character
+        license_text_path = os.path.abspath(expanduser(license_text_path))
+        if not _exists(license_text_path):
             print("The license text path does not exist.")
             sys.exit(errno.EINVAL)
 
@@ -789,13 +779,12 @@ def main(parser, options, args):
         print('Please fix the input file and re-run the tool.')
         sys.exit(errno.EINVAL)
 
-    # Clear the log file
-    # FIXME: we should just delete the file, not override it
-    # or we should append to it...
-    with open(output_path + LOG_FILENAME, 'w'):
-        pass
+    # Remove the previous log file if exist
+    log_path = join(output_path, LOG_FILENAME)
+    if exists(log_path):
+        os.remove(log_path)
 
-    file_handler = logging.FileHandler(output_path + LOG_FILENAME)
+    file_handler = logging.FileHandler(log_path)
     file_logger.addHandler(file_handler)
 
     input_list = gen.get_input_list(input_path)
@@ -819,30 +808,25 @@ def main(parser, options, args):
             print("The '--copy_files' <project_path> must be a directory.")
             print("'--copy_files' is skipped.")
         else:
-            # if not copy_files_path.endswith('/'):
-            #   copy_files_path += '/'
-            project_parent_dir = dirname(copy_files_path)
             licenses_in_project = True
             license_list = gen.verify_files_existence(input_list,
-                                                      project_parent_dir,
+                                                      copy_files_path,
                                                       licenses_in_project)
             if not license_list:
                 print("None of the file is found. '--copy_files' is ignored.")
             else:
                 gen.copy_files(output_path, license_list)
 
     if license_text_path:
+        print(normpath(license_text_path))
         if not isdir(license_text_path):
             print("The '--license_text_location' <license_path> "
                   "must be a directory.")
             print("'--license_text_location' is skipped.")
         else:
-            # if not license_text_path.endswith('/'):
-            #    license_text_path += '/'
-            license_dir = dirname(license_text_path)
             licenses_in_project = False
             license_list = gen.verify_files_existence(input_list,
-                                                      license_dir,
+                                                      license_text_path,
                                                       licenses_in_project)
             if not license_list:
                 print("None of the file is found. '--copy_files' is ignored.")

about_code_tool/about.py

@@ -22,14 +22,14 @@
 
 from __future__ import print_function
 
-
 import csv
 import errno
 import logging
 import optparse
+import os
 import sys
 
-from os.path import exists, dirname, join, abspath, isdir, basename
+from os.path import exists, dirname, join, abspath, isdir, basename, expanduser, normpath
 
 from about import Collector
 import genabout
@@ -157,8 +157,8 @@ def main(parser, options, args):
     input_path, output_path, component_subset_path = args
 
     # TODO: need more path normalization (normpath, expanduser)
-    # input_path = abspath(input_path)
-    output_path = abspath(output_path)
+    input_path = expanduser(normpath(input_path))
+    output_path = expanduser(normpath(output_path))
 
     # Add the following to solve the
     # UnicodeEncodeError: 'ascii' codec can't encode character
@@ -182,6 +182,13 @@ def main(parser, options, args):
         parser.print_help()
         sys.exit(errno.EEXIST)
 
+    if template_location:
+        template_location = abspath(expanduser(template_location))
+        if not exists(expanduser(template_location)):
+            print('The defined template location does not exist.')
+            parser.print_help()
+            sys.exit(errno.EINVAL)
+
     if component_subset_path and not exists(component_subset_path):
         print('Component Subset path does not exist.')
         parser.print_help()
@@ -212,15 +219,22 @@ def main(parser, options, args):
             outlist = update_path_to_about(sublist)
 
         attrib_str = collector.generate_attribution(template_path=template_location, limit_to=outlist)
-        with open(output_path, "w") as f:
-            f.write(attrib_str)
         errors = collector.get_genattrib_errors()
 
-        # Clear the log file
-        with open(join(dirname(output_path), LOG_FILENAME), 'w'):
-            pass
+        if attrib_str:
+            try:
+                with open(output_path, "w") as f:
+                    f.write(attrib_str)
+            except Exception as e:
+                print("Problem occurs. Attribution was not generated.")
+                print(e)
+
+        # Remove the previous log file if exist
+        log_path = join(dirname(output_path), LOG_FILENAME)
+        if exists(log_path):
+            os.remove(log_path)
 
-        file_handler = logging.FileHandler(join(dirname(output_path), LOG_FILENAME))
+        file_handler = logging.FileHandler(log_path)
         file_logger.addHandler(file_handler)
         for error_msg in errors:
             logger.error(error_msg)

about_code_tool/genabout.py

@@ -41,11 +41,7 @@ <h1>OPEN SOURCE SOFTWARE INFORMATION</h1>
 
         <div class="oss-table-of-contents">
             {% for about_object in about_objects %}
-                <p><a href="#component_{{ loop.index0 }}">{{ about_object.name }}
-                    {% if about_object.version %} 
-                        {{ about_object.version }}
-                    {% endif %}
-                </a></p>
+                <p><a href="#component_{{ loop.index0 }}">{{ about_object.name }}{% if about_object.version %} {{ about_object.version }}{% endif %}</a></p>
             {% endfor %}
         </div>
 
@@ -67,13 +63,29 @@ <h3 class="component-name">{{ about_object.name }}
                 {% elif about_object.notice_file %}
                     <pre class="component-notice">{{ about_object.notice_text }}</pre>
                 {% endif %}
-                {% if about_object.license_text %}
-                    <pre>{{about_object.license_text | e}}</pre>
+                {% if about_object.dje_license_name in common_licenses %}
+                    <p>Full text of
+                        <a class="{{ about_object.dje_license_name }}" href="#component-license-{{ about_object.dje_license_name }}">
+                         {{ about_object.dje_license_name }}
+                         </a>
+                            is available at the end of this document.</p>
+                {% else %}
+                    {% if about_object.license_text %}
+                        <pre>{{about_object.license_text | e}}</pre>
+                    {% endif %}
                 {% endif %}
             </div>
         {% endfor %}
         <hr>
 
+        <h3>Common Licenses Used in This Product</h3>
+        {% for index in range(license_keys | count) %}
+            {% if license_keys[index] in common_licenses %}
+                <h3 id="component-license-{{ license_keys[index] }}">{{ license_keys[index] }}</h3>
+                <pre>{{ license_texts[index]|e }}</pre>
+            {% endif %}
+        {% endfor %}
+
         <h3><a id="End">End</a></h3>
     </body>
 </html>