Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-39953

Resources > add ability to define custom copyright options

    XMLWordPrintable

    Details

    • Type: Feature Request
    • Status: Verified
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 11.4
    • Fix Version/s: 19.0
    • Component/s: Config, Content, Kernel, Library
    • Labels:
      None
    • 12 status:
      Won't Fix
    • Property addition/change required:
      Yes
    • Test Plan:
      Hide

      Custom copyright options must be tested on the experimental nightly server: https://experimental.nightly.sakaiproject.org/portal

      1) In a project site, go to the Resources tool
      2) Select several Resources to be uploaded
      3) Verify the 'Copyright Status' drop down control is present on the form
      4) Verify the dropdown does not contain the 'Use below' entry
      5) Do not select a valid option for the 'Copyright Status' (leave the selection as 'Please select a copyright status')
      6) Click 'Continue'
      7) Verify that you are presented with an error message indicating that you are required to select a valid copyright status for the files
      9) For each entry in the drop down (other than the 'Please select...' entry), verify that the '(more info)' link presents a pop-up with different information (select a valid option, then click the link, then select a different option, click the link, etc.)
      8) Select a valid copyright status from the drop down (anything other than the 'Please select...' option)
      9) Click 'Continue'
      10) Verify that the upload was successful, and that each of the files uploaded retains the selected copyright status (go to 'Edit Details' to see the copyright status of any file)
      11) Repeat steps 1-10 with a course site
      12) Repeat steps 1-10 in a user's Home site

      Show
      Custom copyright options must be tested on the experimental nightly server: https://experimental.nightly.sakaiproject.org/portal 1) In a project site, go to the Resources tool 2) Select several Resources to be uploaded 3) Verify the 'Copyright Status' drop down control is present on the form 4) Verify the dropdown does not contain the 'Use below' entry 5) Do not select a valid option for the 'Copyright Status' (leave the selection as 'Please select a copyright status') 6) Click 'Continue' 7) Verify that you are presented with an error message indicating that you are required to select a valid copyright status for the files 9) For each entry in the drop down (other than the 'Please select...' entry), verify that the '(more info)' link presents a pop-up with different information (select a valid option, then click the link, then select a different option, click the link, etc.) 8) Select a valid copyright status from the drop down (anything other than the 'Please select...' option) 9) Click 'Continue' 10) Verify that the upload was successful, and that each of the files uploaded retains the selected copyright status (go to 'Edit Details' to see the copyright status of any file) 11) Repeat steps 1-10 with a course site 12) Repeat steps 1-10 in a user's Home site

      Description

      The linked PR introduces the following new features:

      • ability for an institution to define and use an arbitrary number of custom copyright options
        • enabled/disabled via sakai.property "copyright.useCustom", which defaults to false
        • custom copyright options are defined via /content/content-copyright/impl/src/bundle/org/sakaiproject/content/copyright/copyright.properties
      • ability to force users to explicitly select copyright status for files
        • enabled/disabled via sakai.property "copyright.requireChoice", which defaults to false
        • works with both default and custom copyright options
        • if set to true, inputs a "Please select a copyright status" entry in the copyright drop down (always first element in the list)
        • client and server side validation to reject saving the resource if the drop down was not set to a value other than the "Please select..."
      • adds the copyright drop down form field to the upload resources form (accessed from both the Resources tool and the Drop Box tool)
        • one drop down, setting applies to all files uploaded
        • previously was only present on the 'Edit Details' form

      The linked PR also includes refactoring existing copyright code, removing old and unused copyright sakai.properties, and improved documentation of the current state of valid copyright sakai.properties in default.sakai.properties.

      The following sakai.properties have been added:

      # SAK-39953 - use custom copyright options rather than the predefined list
      # NOTE: define your custom copyright options in /content/content-copyright/impl/src/bundle/org/sakaiproject/content/copyright/copyright.properties
      # NOTE: examples are defined in the above file, with the keys 'custom.copyright.#'; define as many or as few as needed by your institution
      # DEFAULT: false
      # copyright.useCustom=true
      
      # SAK-39953 - require users to explicity define the copyright status for uploaded files in the Resources tool
      # NOTE: does not require any other copyright sakai.properties to be set (works with defaults, copyright.types and custom copyright)
      # DEFAULT: false
      # copyright.requireChoice=true
      

      The following sakai.properties have been removed:

      ## NOTE: these copyright properties may not be valid anymore - 8 Sept 2011
      # default.copyright=Copyright status is not yet determined.
      # default.copyright.alert=true
      # fairuse.url=http://fairuse.stanford.edu
      # newcopyrightinput=true
      
      • default.copyright was made obsolete via KNL-1399 (and re-implemented in the linked PR)
      • default.copyright.alert was some legacy property, not really sure what it once did
      • fairuse.url from sakai.properties was not being used; the functionality of overriding the default value was moved into message bundles (/content/content-tool/tool/src/bundle/right.properties) some time ago, so I provided some more documentation there about what it does and how to customize it properly
      • newcopyrightinput was another legacy property not being used; not sure what it once did
        • for all of the above: removed some lingering code in /content/ project that was still referencing these and sticking them in the STATE but never actually using it

        Gliffy Diagrams

          Attachments

          1. screenshot-1.png
            screenshot-1.png
            85 kB
          2. screenshot-2.png
            screenshot-2.png
            138 kB
          3. screenshot-3.png
            screenshot-3.png
            27 kB

            Issue Links

              Activity

                People

                • Assignee:
                  bjones86 Brian Jones
                  Reporter:
                  bjones86 Brian Jones
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  5 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Git Source Code