CODEWITHSUNDEEP
iosplistsettings.bundle
JosephH
JosephH

Reputation: 37505

best way to add license section to iOS settings bundle

My iOS application uses a number of third party components licensed under Apache 2.0 and similar licenses, which requires me to include various bits of text, this kind of thing:

* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

There seems to be a reasonable precedent for putting this information under a 'License' subentry in settings bundle (on the ipad facebook, pages, keynote, numbers and wikipanion all seem to do this).

I'm struggling a bit to actually achieve the same though; I seem to need to split the text up line by line and enter into xcode a line at a time (and xcode4 seems to have a crashing problem when editing the plists).

It seems like the kind of thing that there's almost certainly a somewhere script to do, or some simple way to do it that I've missed.

Upvotes: 127

Views: 50064

Answers (11)

iwatachan
iwatachan

Reputation: 329

Wait, license notation is not a setting.

Edit: I think license notice is not a setting. I think it is irrational to expect users who want to check the license notice to open the settings app. Therefore, I thought we should create a page for the license notice in the appropriate place in the app.

Upvotes: -1

Justin Meiners
Justin Meiners

Reputation: 11143

I had to modify sean's script for modern python3:

import os
import sys
import plistlib
from copy import deepcopy

os.chdir(sys.path[0])

plist = {'PreferenceSpecifiers': [], 'StringsTable': 'Acknowledgements'}
base_group = {'Type': 'PSGroupSpecifier', 'FooterText': '', 'Title': ''}

for filename in os.listdir("."):
    if filename.endswith(".license"):
        with open(filename, 'r') as current_file:
            group = deepcopy(base_group)
            title = filename.split(".license")[0]
            group['Title'] = title
            group['FooterText'] = current_file.read()
            plist['PreferenceSpecifiers'].append(group)

with open("Acknowledgements.plist", "wb") as f:
    plistlib.dump(plist, f)

Upvotes: 0

CrystalMath
CrystalMath

Reputation: 41

Aknowlist is a strong CocoaPod candidate that is actively maintained at the time of this writing. It automates this licensing if you are okay with housing the licenses in your app rather than the settings bundle. It worked great for the project I was working on.

Upvotes: 0

Yvo
Yvo

Reputation: 19263

Ack Ack: Acknowledgement Plist Generator
A while back I've created a Python script that scans for license files and creates a nice Acknowledgements plist that you can use in your Settings.plist. It does a lot of the work for you.

https://github.com/Building42/AckAck

Features

  • Detects Carthage and CocoaPods folders
  • Detects existing plists for custom licenses
  • Cleans up the license texts by removing unnecessary new lines and line breaks
  • Provides many customization options (see --help for details)
  • Supports both Python v2 and v3

Install

wget https://raw.githubusercontent.com/Building42/AckAck/master/ackack.py
chmod +x ackack.py

Run

./ackack.py

Screenshot

Acknowledgements

If you have suggestions for improvements, feel free to post an issue or pull request on GitHub!

Upvotes: 1

D. Rothschild
D. Rothschild

Reputation: 719

The Python script from Sean in this thread works. But there a couple of basic things to know.

  1. in Xcode, right click on the top of the Project Navigator tree, on the name of your project, and add a New Group. This puts a new folder in your project.
  2. Add Sean's script there and make sure to save it as: Acknowledgements.py.
  3. Make sure you have Python installed on your system. I'm using a Mac.
  4. Add a first license file to the folder you created in 1. Make it simple like just having one word in the file, say: Testing. Save it in the folder as Test1.license.
  5. Set up your Settings.bundle as per JosephH above.
  6. Use your Terminal app to CD to the folder you created in 1.
  7. Run the script. Type: python Acknowledgements.py. If you get no errors it will return right back to the Terminal prompt. Do all of this before adding any run script to the Build.
  8. Build and run your app.
  9. Double tap on the iPhone home button and kill Settings. It doesn't often pick up the Settings change for your app until Settings restarts.
  10. After restarting Settings, go to your app and look to see if it worked.
  11. If that all worked, slowly add more license files but run the script each time. You can get errors running the script because of certain characters in the file so the easy way to debug is to add a file, run the script, see if it worked and proceed. Else, edit any special characters out of the .license file.
  12. I did not get the Run Build Script work per the instructions above. But this process works fine if you are not changing the .license files that often.

Upvotes: 2

JosephH
JosephH

Reputation: 37505

I think I've now managed to solve all the problems I was running into.

  • It seems to be best to use group element titles to hold the licenses (this is what Apple do in the iWork apps). There is however a limit on the length of these (and I've not yet discovered exactly what the limit is), so you need to break each license file into multiple strings.
  • You can create a line break within these by include a literal carriage return (ie. otherwise known as ^M, \r or 0x0A)
  • Make sure not to include any literal "s mid-text. If you do, some or all of the strings in the file will get silently ignored.

I've got a convenience script I use to help generate the .plist and .strings file, shown below.

To use it:

  1. Create a 'licenses' directory under your project
  2. Put script into that directory
  3. Put each license into that directory, one per file, with filenames that end .license
  4. Perform any necessary reformatting on the licenses. (eg. remove extra spaces at the beginning of lines, ensure that there are no line breaks mid-paragraph). There should be a blank line in-between each paragraph
  5. Change to licenses directory & run the script
  6. Edit your settings bundle Root.plist to include a child section called 'Acknowledgements'

Here's the script:

#!/usr/bin/perl -w

use strict;

my $out = "../Settings.bundle/en.lproj/Acknowledgements.strings";
my $plistout =  "../Settings.bundle/Acknowledgements.plist";

unlink $out;

open(my $outfh, '>', $out) or die $!;
open(my $plistfh, '>', $plistout) or die $!;

print $plistfh <<'EOD';
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
        <key>StringsTable</key>
        <string>Acknowledgements</string>
        <key>PreferenceSpecifiers</key>
        <array>
EOD
for my $i (sort glob("*.license"))
{
    my $value=`cat $i`;
    $value =~ s/\r//g;
    $value =~ s/\n/\r/g;
    $value =~ s/[ \t]+\r/\r/g;
    $value =~ s/\"/\'/g;
    my $key=$i;
    $key =~ s/\.license$//;

    my $cnt = 1;
    my $keynum = $key;
    for my $str (split /\r\r/, $value)
    {
        print $plistfh <<"EOD";
                <dict>
                        <key>Type</key>
                        <string>PSGroupSpecifier</string>
                        <key>Title</key>
                        <string>$keynum</string>
                </dict>
EOD

        print $outfh "\"$keynum\" = \"$str\";\n";
        $keynum = $key.(++$cnt);
    }
}

print $plistfh <<'EOD';
        </array>
</dict>
</plist>
EOD
close($outfh);
close($plistfh);

Setting up your Settings.bundle

If you haven't created a Settings.bundle, go to File --> New --> New File...

Under the Resource section, find the Settings Bundle. Use the default name and save it to the root of your project.

Expand the Settings.bundle group and select Root.plist. You will need to add a new section where its key will be Preference Items of type Array. Add the following information:

enter image description here

The Filename key points to the plist that was created by this script. You can change the title to what ever you want.

Execute Script At Build Time

Also, if you want this script to run whenever you build your project, you can add a build phase to your target:

  1. Go to your project file
  2. Select the target
  3. Click the Build Phases tab
  4. In the lower right corner of that pane, click on 'Add Build Phase'
  5. Select 'Add Run Script'
  6. Drag and drop your perl script into the section for your script. Modify to look something like this:
  1. cd $SRCROOT/licenses ($SRCROOT points to the root of your project)
  2. ./yourScriptName.pl

After you have finished that, you can drag the Run Script build phase sooner in the build process. You'll want to move it up before Compile Sources so that the updates to your Settings Bundle get compiled and copied over.

Update for iOS 7: iOS 7 seems to handle the "Title" key different and is messing up the rendered text. To fix that the generated Acknowledgements.plist needs to use the "FooterText" key instead of "Title". This how to change the script:

for my $str (split /\r\r/, $value)
{
    print $plistfh <<"EOD";
            <dict>
                    <key>Type</key>
                    <string>PSGroupSpecifier</string>
                    <key>FooterText</key> # <= here is the change
                    <string>$keynum</string>
            </dict>
 EOD

    print $outfh "\"$keynum\" = \"$str\";\n";
    $keynum = $key.(++$cnt);
}

Upvotes: 199

carloe
carloe

Reputation: 1540

I thought I'd throw my iteration on Sean's awesome python code in the mix. The main difference is that it takes an input directory and then recursively searches it for LICENSE files. It derives the title value from the parent directory of the LICENSE file, so it plays well with cocoapods.

The motivation was to create a build script to automatically keep the legal section of my app up to date as I add or remove pods. It also does some other things like remove forced newlines from licenses so the paragraphs look a bit better on the devices.

https://github.com/carloe/LicenseGenerator-iOS

enter image description here

Upvotes: 15

mattti
mattti

Reputation: 53

This is an addendum to JosephH's answer. (I don't have the rep to comment)

I had to move <key>StringsTable</key> <string>Acknowledgements</string> down to above the last </dict> in the Perl script.

Before this modification, the Acknowledgements Section in the App was empty and XCode couldn't read the resulting Acknowledgements.plist. ( "The data couldn’t be read because it isn’t in the correct format.")

(XCode 6.3.2 iOS 8.3)

Upvotes: 2

JosephH
JosephH

Reputation: 37505

As an alternative, for those using CocoaPods, it will generate an 'Acknowledgements' plist for each target specified in your Podfile which contains the License details for each Pod used in that target (assuming details have been specified in the Pod spec). The property list file that can be added to the iOS settings bundle.

There's also projects under way to allow this data to be converted and displayed within the app instead:

https://github.com/CocoaPods/cocoapods-install-metadata

https://github.com/cocoapods/CPDAcknowledgements

Upvotes: 16

cvknage
cvknage

Reputation: 268

I made a script in Ruby inspiered by @JosephH script. This version will, in my own opinion, better represent the individual open source projects.

Wisit iOS-AcknowledgementGenerator to download the script and sample project.

This is what acknowledgements will look like in your App:

Settings.app Settings.bundle Acknowledgements enter image description here

Upvotes: 8

Sean
Sean

Reputation: 781

Here's the same solution that @JosephH provided (without translations), but done in Python for anyone who prefers python over perl

import os
import sys
import plistlib
from copy import deepcopy

os.chdir(sys.path[0])

plist = {'PreferenceSpecifiers': [], 'StringsTable': 'Acknowledgements'}
base_group = {'Type': 'PSGroupSpecifier', 'FooterText': '', 'Title': ''}

for filename in os.listdir("."):
    if filename.endswith(".license"):
        current_file = open(filename, 'r')
        group = deepcopy(base_group)
        title = filename.split(".license")[0]
        group['Title'] = title
        group['FooterText'] = current_file.read()
        plist['PreferenceSpecifiers'].append(group)

plistlib.writePlist(
    plist,
    "../Settings.bundle/Acknowledgements.plist"
)

Upvotes: 37

Related Questions