commit f52081f8000dffbabb5d64972f2a360dab84fe2a from: Matthias L. Jugel date: Tue Mar 14 17:37:23 2023 UTC initial commit commit - /dev/null commit + f52081f8000dffbabb5d64972f2a360dab84fe2a blob - /dev/null blob + 485dee64bcfb48793379b200a1afd14e85a8aaf4 (mode 644) --- /dev/null +++ .gitignore @@ -0,0 +1 @@ +.idea blob - /dev/null blob + d645695673349e3947e8e5ae42332d0ac3164cd7 (mode 644) --- /dev/null +++ LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. blob - /dev/null blob + 9ae67ed11046e5881abf91f793ebb787285beff6 (mode 644) --- /dev/null +++ README.md @@ -0,0 +1,43 @@ +# PhotosTagger + +A collection of scripts to script Apple Photos.app to overcome +issues with the Family Sharing, which shares the photos, but not +the folder and album structure. + +There are two scripts: +- [PhotosTagger.sh](src/PhotosTagger.js) -- adds keywords to all media items with the folder/album path +- [PhotosCreateFolders.js](src/PhotosCreateFolders.js) -- reads keywords and re-creates the folder and album structure + +## Examples: + +Tag all photos in sorted folder: +```shell +./photos.sh tag Sorted +``` + +Create the folder structure +```shell +./photos.sh folder TargetFolder +``` + +## Disclaimer + +No guarantee that this works as expected. I tested it as good +as possible. It works for me. + +--- +``` +Copyright 2023 Matthias L. Jugel + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +``` blob - /dev/null blob + 7f171ac01e6cc7d2cf54eaee82b6374347b5f243 (mode 755) --- /dev/null +++ photos.sh @@ -0,0 +1,11 @@ +#!/usr/bin/env bash + +if [ "$1" = "tag" ]; then + shift + /usr/bin/osascript -l JavaScript src/PhotosTagger.js $* +elif [ "$1" == "folder" ]; then + shift + /usr/bin/osascript -l JavaScript src/PhotosCreateFolders.js $* +else + echo "usage: $0 [tag|folder] " +fi blob - /dev/null blob + 053b08341b3ba9a2cfc0ef559654cb5ea164ae9b (mode 755) --- /dev/null +++ src/PhotosCreateFolders.js @@ -0,0 +1,65 @@ +// photos recreate folder structure script +const TAGPREFIX = "P:" + +ObjC.import('stdlib') +const argv = $.NSProcessInfo.processInfo.arguments.js.splice(4); + +let app = Application('Photos'); +app.includeStandardAdditions = true + +const baseFolder = argv.length === 0 ? app : app.folders.byName(argv[0].js); +console.log(`!! target folder: ${baseFolder.name()}`); + +// find the album `albumName` below the folder `folder` with the specified path +// creates the folder structure and the album, if not already existing +function findAlbum(folder, path, albumName) { + //console.log(`== findAlbum({${folder.name()}}, [${path}], "${albumName}")`); + + // we arrived at the lowest folder level, check if the album exists + if(path.length === 0) { + const album = folder.albums.whose({name: albumName}); + if(album.length === 0) { + console.log(`> creating new album: ${albumName} at ${folder.name()}`); + return app.make({new: "album", named: albumName, at: folder}); + } else { + //console.log(`> existing album found: ${albumName} at ${folder.name()}`); + return album[0]; + } + } + + // find a folder with the expected name at the current level + const foundFolder = folder.folders.whose({name: path[0]}); + if (foundFolder.length === 0) { + console.log(`> creating new folder: ${path[0]} at ${folder.name()}`); + const subFolder = app.make({new: "folder", named: path[0], at: folder }); + return findAlbum(subFolder, path.slice(1), albumName); + } else { + return findAlbum(foundFolder[0], path.slice(1), albumName); + } +} + +// keep a cache of existing albums at their path (no need to traverse again) +var albums = new Map(); + +// check all media items with a keyword prefixed by 'P:' +app.mediaItems().forEach(m => { + const keywords = m.keywords(); + if (keywords) { + keywords.filter(k => k.startsWith(TAGPREFIX)).forEach(p => { + var album = albums.get(p); + if(!album) { + //console.log(`>> analyzing ${p} for ${m.filename()}`); + const pathElements = p.substring(2).split("/"); + const albumName = pathElements.pop(); + album = findAlbum(baseFolder, pathElements, albumName); + albums.set(p, album); + } + // only add to album, if the photo is not already added + if(album.mediaItems.whose({id: m.id()}).length === 0) { + console.log(`>> adding ${m.filename()} to ${p.substring(2)}`); + app.add([m], {to: album}); + } + }); + } +}); +$.exit(0) blob - /dev/null blob + 2c21de89a8a5f0b1459282da9cd85923bc561eda (mode 755) --- /dev/null +++ src/PhotosTagger.js @@ -0,0 +1,53 @@ +// tags all photos with the folder/album structure +const REMOVETAGS = false; +const TAGPREFIX = "P:" + +ObjC.import('stdlib'); +const argv = $.NSProcessInfo.processInfo.arguments.js.splice(4); +if(argv.length === 0) { + console.log("photos tagger: use a root folder!") + $.exit(0); +} +const ROOT = argv[0].js; + +let app = Application('Photos'); +app.includeStandardAdditions = true + +function collectAlbums(r, p, children) { + if (children.length === 0) return r; + for (var c of children) { + const childPath = p + "/" + c.name(); + for (var a of c.albums()) { + var path = childPath + "/" + a.name(); + if (path[0] === '/') path = path.substring(1); + r.set(path, a); + if (path.startsWith(ROOT)) { + const tag = TAGPREFIX + path; + a.mediaItems().forEach((m) => { + const keywords = m.keywords(); + if(!keywords || !keywords.includes(tag)) { + console.log(`> ${m.filename()} tag '${tag}'`); + if(!keywords) m.keywords.set([tag]); + else m.keywords.set([...new Set([...keywords, ...[tag]])]); + } else if(REMOVETAGS && keywords && keywords.includes(tag)) { + console.log(`< ${m.filename()} tag '${tag}'`); + const idx = keywords.indexOf(tag); + m.keywords.set(keywords.splice(idx, idx)); + } + }); + } + } + r = new Map([...r, ...collectAlbums(r, childPath, c.folders())]); + } + return r; +} + +let albums = new Map(app.albums().map((a) => [a.name(), a])); +let folders = new Map(app.folders().map((f) => [f.name(), f])); + +console.log("== target folder: '"+ROOT+"'"); +console.log("== top level albums: " + Array.from(albums.keys())); +console.log("== top level folders: " + Array.from(folders.keys())); + +collectAlbums(albums, "", app.folders()); +$.exit(0)