Changeset 857:2a85b3f15ff9

Timestamp:

03/10/10 12:40:08 (6 months ago)

Author:

johnbywater

Branch:

default

Parents:

856:53f62c87b551 (diff), 855:68630d75f031 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge.

Location:

ckan

Files:

• getdata/cospread.py (modified) (2 diffs)
• getdata/cospread.py (modified) (1 diff)
• getdata/data4nr.py (modified) (1 diff)
• getdata/data4nr.py (modified) (1 diff)
• getdata/ons_import.py (modified) (2 diffs)
• getdata/ons_import.py (modified) (1 diff)
• lib/create_test_data.py (modified) (9 diffs)
• lib/create_test_data.py (modified) (3 diffs)
• lib/package_saver.py (modified) (1 diff)
• lib/package_saver.py (modified) (4 diffs)
• lib/search.py (modified) (2 diffs)
• lib/search.py (modified) (7 diffs)
• model/core.py (modified) (9 diffs)
• model/core.py (modified) (1 diff)
• templates/package/read_core.html (modified) (2 diffs)
• templates/package/read_core.html (modified) (1 diff)

ckan/getdata/cospread.py

@@ -140 +140 @@
                            _dict['%s - standard' % field] == 'Other (specify)' else \
                            _dict['%s - standard' % field]
-        if 'HESA' in _dict['licence']:
-            license_str = u'OKD Compliant::Higher Education Statistics Agency Copyright with data.gov.uk rights'
-        else:
-            license_str = u'OKD Compliant::UK Crown Copyright with data.gov.uk rights'
+        #if 'HESA' in _dict['licence']:
+        #    license_title = u'OKD Compliant::Higher Education Statistics Agency Copyright with data.gov.uk rights'
+        #else:
+        #    license_title = u'OKD Compliant::UK Crown Copyright with data.gov.uk rights'
 
         # extras
@@ -240 +240 @@
             pkg.add_resource(resource['url'], format=format, description=resource['description'])
         pkg.notes=notes
-        pkg.license = model.License.by_name(license_str)
+        pkg.license_id = u'dsl' # Todo: Fix this. model.License.by_name(license_str)
         assert pkg.license
         if not existing_pkg:

ckan/getdata/cospread.py

@@ -299 +299 @@
             group = model.Group(name=self._groupname)
             model.Session.add(group)
+            user = model.User.by_name(self._username)
+            model.setup_default_user_roles(group, [user])
 
     def _new_revision(self):

ckan/getdata/data4nr.py

@@ -123 +123 @@
         pkg.add_resource(res_url, description=res_description)
         pkg.notes=notes
-        license_str = u'OKD Compliant::UK Crown Copyright with data.gov.uk rights'
-        pkg.license = model.License.by_name(license_str)
+        pkg.license_id = u'dsl' # Todo: Fix this.
         if not existing_pkg:
             user = model.User.by_name(self._username)

ckan/getdata/data4nr.py

@@ -188 +188 @@
             group = model.Group(name=self._groupname)
             model.Session.add(group)
+            user = model.User.by_name(self._username)
+            model.setup_default_user_roles(group, [user])
 
         self._existing_pkgs = []

ckan/getdata/ons_import.py

@@ -119 +119 @@
         pkg.title = title
         pkg.notes = '\n\n'.join(notes_list)
-        pkg.license = model.Session.query(model.License).get(self._crown_license_id)
+        pkg.license_id = self._crown_license_id
         pkg.extras = extras
         if extras['department']:
@@ -190 +190 @@
         self._item_count = 0
         self._new_package_count = 0
-        license_str = u'OKD Compliant::UK Crown Copyright with data.gov.uk rights'
-        self._crown_license_id = model.License.by_name(license_str).id
+        self._crown_license_id = u'dsl' # Todo: Fix this.
 
 

ckan/getdata/ons_import.py

@@ -208 +208 @@
             group = model.Group(name=groupname)
             model.Session.add(group)
+            user = model.User.by_name(username)
+            model.setup_default_user_roles(group, [user])
 
         if model.Session.new:

ckan/lib/create_test_data.py

@@ -108 +108 @@
                         pkg.groups.append(group)
                 elif attr == 'license':
-                    license = model.License.by_name(val)
-                    pkg.license = license
+                    pkg.license_id = val
                 elif attr == 'license_id':
-                    license = model.Session.query(model.License).get(val)
-                    pkg.license = license
+                    pkg.license_id = val
                 elif attr == 'extras':
                     pkg.extras = val
@@ -204 +202 @@
         pkg2.tags = [ tag1 ]
         self.tag_names = [u'russian', u'tolstoy']
-        license1 = model.License.by_name(u'OKD Compliant::Other')
-        pkg1.license = license1
+        pkg1.license_id = u'agpl-v3'
         pkg2.title = u'A Wonderful Story'
         genre_extra = model.PackageExtra(key=u'genre', value='romantic novel')
@@ -284 +281 @@
               'tags':'registry  country-usa  government  federal  gov  workshop-20081101',
               'groups':'ukgov test1 test2 penguin',
-              'license':'OKD Compliant::Other',
+              'license':'agpl-v3',
               'notes':'''From <http://www.gpoaccess.gov/gils/about.html>
               
@@ -297 +294 @@
               'tags':'images  graphics  photographs  photos  pictures  us  usa  america  history  wildlife  nature  war  military  todo-split  gov',
               'groups':'ukgov test1 penguin',
-              'license':'OKD Compliant::Other',
+              'license':'agpl-v3',
               'notes':'''## About
 
@@ -313 +310 @@
               'tags':'us  courts  case-law  us  courts  case-law  gov  legal  law  access-bulk  penguins penguin',
               'groups':'ukgov test2 penguin',
-              'license':'OKD Compliant::Creative Commons CCZero',
+              'license':'cc-zero',
               'notes':'''### Description
 
@@ -335 +332 @@
               'groups':'penguin',              
               'tags':'country-sweden  format-pdf  access-www  documents  publications  government  eutransparency',
-              'license':'Other::License Not Specified',
+              'license':'',
               'notes':'''### About
 
@@ -351 +348 @@
               'download_url':'http://www.opengov.se/data/open/',
               'tags':'country-sweden  government  data',
-              'license':'OKD Compliant::Creative Commons Attribution-ShareAlike',
+              'license':'cc-by-sa',
               'notes':'''### About
 
@@ -379 +376 @@
      'author':'DCSF Data Services Group',
      'author_email':'statistics@dcsf.gsi.gov.uk',
-     'license':'Non-OKD Compliant::Crown Copyright',
+     'license':'dsl',
      'tags':'children fostering',
      'extras':{
@@ -406 +403 @@
      'author':'DECC Energy Statistics Team',
      'author_email':'energy.stats@decc.gsi.gov.uk',
-     'license':'Non-OKD Compliant::Crown Copyright',
+     'license':'dsl',
      'tags':'fuel prices',
      'extras':{

ckan/lib/create_test_data.py

@@ -56 +56 @@
         self.pkg_names = []
         self.tag_names = []
-        self.group_names = []
+        self.group_names = set()
         self.user_names = extra_user_names
         admins_list = [] # list of (package_name, admin_names)
@@ -104 +104 @@
                         if not group:
                             group = model.Group(name=group_name)
-                            self.group_names.append(group_name)
+                            self.group_names.add(group_name)
                             model.Session.add(group)
                         pkg.groups.append(group)
@@ -129 +129 @@
             user = model.User(name=unicode(user_name))
             model.Session.add(user)
+        for group_name in self.group_names:
+            model.setup_default_user_roles(group)
         model.repo.commit_and_remove()
 

ckan/lib/package_saver.py

@@ -73 +73 @@
         # remove everything from session so nothing can get saved accidentally
         model.Session.clear()
-        # license field's _id only updated, not object.id, so cludge that:
-        if fs.model.license_id:
-            fs.model.license = model.Session.query(model.License).get(fs.model.license_id)
         return out
 

ckan/lib/package_saver.py

@@ -17 +17 @@
                        log_message=None,
                        author=None):
-        'Renders a package on the basis of a fieldset - perfect for preview'
+        '''Renders a package on the basis of a fieldset - perfect for
+        preview of form data.
+        Note that the actual calling of render('package/read') is left
+        to the caller.'''
         pkg = cls._preview_pkg(fs, original_name, record_id,
                                log_message, author)
@@ -25 +28 @@
     @classmethod
     def render_package(cls, pkg):
-        'Renders a package'
+        '''Prepares for rendering a package. Takes a Package object and
+        formats it for the various context variables required to call
+        render. 
+        Note that the actual calling of render('package/read') is left
+        to the caller.'''
         c.pkg = pkg
         notes_formatted = ckan.misc.MarkdownFormat().to_html(pkg.notes)
@@ -33 +40 @@
         c.pkg_author_link = cls._person_email_link(c.pkg.author, c.pkg.author_email, "Author")
         c.pkg_maintainer_link = cls._person_email_link(c.pkg.maintainer, c.pkg.maintainer_email, "Maintainer")
+        c.package_relationships = pkg.relationships_printable()
         # c.auth_for_change_state and c.auth_for_edit may also used
         # return render('package/read')
@@ -57 +65 @@
             fs.model.groups
             fs.model.ratings
+            fs.model.relationships_as_subject
+            fs.model.relationships_as_object
         except ValidationException, e:
             # remove everything from session so nothing can get saved accidentally

ckan/lib/search.py

@@ -5 +5 @@
 
 import ckan.model as model
-from licenses import LicenseList
+
 from ckan import authz
 
@@ -277 +277 @@
         return query
         
-    def _update_open_licenses(self):
+    def _update_open_licenses(self):  # Update, or init?
         self._open_licenses = []
-        for license_name in LicenseList.all_formatted:
-            _license = model.License.by_name(license_name, autoflush=False)
-            if _license and _license.isopen():                
-                self._open_licenses.append(_license.id)
+        for license in model.Package.get_license_register().values():
+            if license and license.isopen():
+                self._open_licenses.append(license.id)
 
     def _format_results(self):

ckan/lib/search.py

@@ -5 +5 @@
 
 import ckan.model as model
+
+from ckan import authz
 
 ENABLE_CACHING = bool(config.get('enable_caching', ''))
@@ -60 +62 @@
         return self.run(options)
 
-    def query(self, options):
+    def query(self, options, username=None):
         '''For the given search options, returns a query object.'''
         self._options = options
@@ -70 +72 @@
 
         if self._options.entity == 'package':
-            query = self._build_package_query(general_terms, field_specific_terms)
+            query = authz.Authorizer().authorized_query(username, model.Package)
+            query = self._build_package_query(query, general_terms, field_specific_terms)
         elif self._options.entity == 'tag':
             query = self._build_tags_query(general_terms)
         elif self._options.entity == 'group':
-            query = self._build_groups_query(general_terms)
+            query = authz.Authorizer().authorized_query(username, model.Group)
+            query = self._build_groups_query(query, general_terms)
         else:
             # error
@@ -80 +84 @@
         return query
 
-    def run(self, options):
+    def run(self, options, username=None):
         '''For the given search options, returns query results.'''
-        query = self.query(options)
+        query = self.query(options, username)
 
         self._results = {}
@@ -151 +155 @@
         return general_terms, field_specific_terms
 
-    def _build_package_query(self, general_terms, field_specific_terms):
+    def _build_package_query(self, authorized_package_query,
+                             general_terms, field_specific_terms):
         make_like = lambda x,y: x.ilike('%' + y + '%')
-        query = model.Session.query(model.Package)
+        query = authorized_package_query
         query = query.filter(model.package_search_table.c.package_id==model.Package.id)
 
@@ -206 +211 @@
 
         query = query.distinct()
-        query = query.filter(model.Package.state == model.State.ACTIVE)
         return query
 
@@ -215 +219 @@
         return query
 
-    def _build_groups_query(self, general_terms):
-        query = model.Session.query(model.Group)
+    def _build_groups_query(self, authorized_package_query, general_terms):
+        query = authorized_package_query
         for term in general_terms:
             query = query.filter(model.Group.name.contains(term.lower()))

ckan/model/core.py

@@ -7 +7 @@
 from types import make_uuid
 import full_search
+from license import License, LicenseRegister
 
 ## VDM-specific tables
@@ -13 +14 @@
 
 ## Our Domain Object Tables
-
-license_table = Table('license', metadata,
-        Column('id', types.Integer, primary_key=True),
-        Column('name', types.Unicode(100)),
-        )
 
 package_table = Table('package', metadata,
@@ -30 +26 @@
         Column('maintainer_email', types.UnicodeText),                      
         Column('notes', types.UnicodeText),
-        Column('license_id', types.Integer, ForeignKey('license.id')),
+        Column('license_id', types.UnicodeText),
 )
 
@@ -45 +41 @@
 
 
-vdm.sqlalchemy.make_table_stateful(license_table)
 vdm.sqlalchemy.make_table_stateful(package_table)
 vdm.sqlalchemy.make_table_stateful(package_tag_table)
@@ -117 +112 @@
         return self.__unicode__()
 
-        
-class License(DomainObject):
-    def isopen(self):
-        if self.name and \
-           (self.name.startswith('OKD Compliant')
-            or
-            self.name.startswith('OSI Approved')
-            ):
-            return True
-        return False
 
 class Package(vdm.sqlalchemy.RevisionedObjectMixin,
@@ -181 +166 @@
         _dict['groups'] = [group.name for group in self.groups]
         if self.license:
-            _dict['license'] = self.license.name
+            _dict['license'] = self.license.id
         else:
             _dict['license'] = ''
@@ -207 +192 @@
         else:
             raise NotImplementedError, 'Package relationship type: %r' % type_
-
+            
+            
         rel = package_relationship.PackageRelationship(
             subject=subject,
@@ -252 +238 @@
                     rel_list.append((child_pkg, type_printable))
         return rel_list
+    #
+    ## Licenses are currently integrated into the domain model here.   
+ 
+    @classmethod
+    def get_license_register(self):
+        if not hasattr(self, '_license_register'):
+            self._license_register = LicenseRegister()
+        return self._license_register
+
+    @classmethod
+    def get_license_options(self):
+        register = self.get_license_register()
+        return [(l.title, l.id) for l in register.values()]
+
+    def get_license(self):
+        license = None
+        if self.license_id:
+            license = self.get_license_register()[self.license_id]
+        return license
+
+    def set_license(self, license):
+        if type(license) == License:
+            self.license_id = license.id
+        elif type(license) == dict:
+            self.license_id = license['id']
+        else:
+            msg = "Value not a license object or entity: %s" % repr(license)
+            raise Exception, msg
+
+    license = property(get_license, set_license)
+
 
 class Tag(DomainObject):
@@ -299 +316 @@
 Revision = vdm.sqlalchemy.make_Revision(mapper, revision_table)
 
-mapper(License, license_table,
-    order_by=license_table.c.id)
-
 mapper(Package, package_table, properties={
-    'license':relation(License),
     # delete-orphan on cascade does NOT work!
     # Why? Answer: because of way SQLAlchemy/our code works there are points

ckan/model/core.py

@@ -205 +205 @@
         return self.relationships_as_subject + self.relationships_as_object
 
+    def relationships_printable(self):
+        '''Returns a list of tuples describing related packages, including
+        non-direct relationships (such as siblings).
+        @return: e.g. [(annakarenina, u"is a parent"), ...]
+        '''
+        from package_relationship import PackageRelationship
+        rel_list = []
+        # forward types
+        for rel_as_subject in self.relationships_as_subject:
+            type_printable = PackageRelationship.make_type_printable(rel_as_subject.type)
+            rel_list.append((rel_as_subject.object, type_printable))
+        # reverse types
+        for rel_as_object in self.relationships_as_object:
+            type_printable = PackageRelationship.make_type_printable(\
+                PackageRelationship.forward_to_reverse_type(
+                    rel_as_object.type)
+                )
+            rel_list.append((rel_as_object.subject, type_printable))
+        # sibling types
+        # e.g. 'gary' is a child of 'mum', looking for 'bert' is a child of 'mum'
+        # i.e. for each 'child_of' type relationship ...
+        for rel_as_subject in self.relationships_as_subject:
+            # ... parent is the object
+            parent_pkg = rel_as_subject.object
+            # Now look for the parent's other relationships as object ...
+            for parent_rel_as_object in parent_pkg.relationships_as_object:
+                # and check children
+                child_pkg = parent_rel_as_object.subject
+                if child_pkg != self and \
+                       parent_rel_as_object.type == rel_as_subject.type:
+                    type_printable = PackageRelationship.inferred_types_printable['sibling']
+                    rel_list.append((child_pkg, type_printable))
+        return rel_list
     #
     ## Licenses are currently integrated into the domain model here.   

ckan/templates/package/read_core.html

@@ -20 +20 @@
         <dt>${package_license_icon(c.pkg)}</dt>
         <py:choose test="">
-          <dd py:when="c.pkg.license">${c.pkg.license.name}
-          </dd>
+          <dd py:when="c.pkg.license">${c.pkg.license.title}</dd>
           <dd py:otherwise="">
             License not given
@@ -76 +75 @@
           <p py:when="c.pkg.license">
             This package is licensed
-            <strong>${c.pkg.license.name}</strong>.
+            <strong>${c.pkg.license.title}</strong>.
           </p>
           <p py:otherwise="">

ckan/templates/package/read_core.html

@@ -28 +28 @@
         <dd>${"Resources available for download" if c.pkg.resources else "No resources given"}</dd>
       </dl>
+        <py:if test="c.package_relationships">
+          <h3>Related packages</h3>
+          <ul>
+            <py:for each="pkg, relationship_str in c.package_relationships">
+              <li>${h.literal(relationship_str % (h.link_to(pkg.name, h.url_for(controller="package", action="read", id=pkg.name))))}</li>
+            </py:for>
+          </ul>
+        </py:if>
     </div>