[Proposal] Photo Gallery and Advanced Search Extensions

[paul43210]

Summary

I'd like to propose two new web extensions for inclusion in this repository:

1. web-app-photos - A photo gallery extension with timeline view, EXIF metadata display, map view, and lightbox
2. web-app-advanced-search - An advanced search interface with photo metadata filters (camera, date range, GPS, etc.)

Background

I've been building these extensions for my personal oCIS deployment and have also submitted a backend PR (owncloud/ocis#11912) that adds photo EXIF metadata indexing to Bleve search. The extensions work together to provide a comprehensive photo management experience.

web-app-photos Features

• Timeline View: Photos grouped by capture date (EXIF takenDateTime), with infinite scroll loading backwards from today
• EXIF Metadata Panel: Display camera make/model, aperture, ISO, focal length, exposure time
• Map View: Interactive Leaflet map showing photo locations from GPS coordinates, with marker clustering
• Lightbox: Full-size image viewer with keyboard navigation and swipe gestures
• File Type Support: jpg, jpeg, png, gif, webp, heic

Tech Stack: Vue 3 Composition API, TypeScript, Leaflet.js

web-app-advanced-search Features

• Photo Metadata Filters: Search by camera make/model, date range, aperture, ISO
• Filter Chips: Visual representation of active filters with easy removal
• Search History: Remembers recent searches
• Statistics Panel: Shows search result breakdown by file type

Tech Stack: Vue 3 Composition API, TypeScript

Dependencies

The photo metadata search features depend on backend changes in PR #11912.

Questions for Maintainers

1. Interest Level: Is this something you'd want in web-extensions, or would you prefer these remain as independent repos?

2. Naming: I'm proposing web-app-photos and web-app-advanced-search. Are these names appropriate, or would you prefer alternatives?

3. Scope: Should these be two separate extensions, or would you prefer them combined into one?

4. License: My current repos use Apache-2.0, but I notice web-extensions uses AGPL-3.0. I'm happy to relicense under AGPL-3.0 for contribution.

5. Backend Dependency: The full photo search functionality requires feat(search): Add photo EXIF metadata to search index and WebDAV resultsFeature/photo metadata search ocis#11912. Should I wait for that to merge before submitting PRs here?

Current State

Both extensions are functional and deployed on my personal oCIS instance. They follow oCIS web extension conventions (AMD module format, manifest.json, etc.). Source code is available at:

• https://github.com/paul43210/ocis-photo-addon
• https://github.com/paul43210/ocis-advanced-search

Screenshots

Next Steps

???

Looking forward to your feedback!

[mmattel]

Hey @paul43210 this is awsome, please go ahead !
If you create a PR, mind to update our ocis_full deployment example here and here?
@kobergj FYI, as you are reviewing the ocis PR

[paul43210]

Hey @paul43210 this is awsome, please go ahead ! If you create a PR, mind to update our ocis_full deployment example here and here? @kobergj FYI, as you are reviewing the ocis PR

Thanks @[mmattel] for the green light! I'm excited to contribute this.
Before I create the PRs, I have a few questions to make sure I follow the right approach:

1. Repository location
   Should photo-addon be added to the owncloud/web-extensions repo (under packages/web-app-photo-addon/), or would you prefer it stays as a standalone repo that gets published to the web-extensions Docker image?
2. Version numbering
   I see existing extensions are at 0.3.2. Should I start photo-addon at 0.1.0, or align with the current version?
3. CSP configuration
   The photo-addon loads external resources for its map view feature:
   Leaflet.js from CDN
   OpenStreetMap tiles from tile.openstreetmap.org
   I'll need to include CSP configuration updates similar to how externalsites does. Should I add these to config/ocis/csp.yaml in the deployment example?
4. PR strategyShould I:

Create one PR to web-extensions with the extension code, then a separate PR to ocis for the deployment example updates?
Or combine everything into a single PR?

5. Deployment files needed
   Based on the existing patterns, I'm planning to add:

.env entry: #PHOTOADDON=:web_extensions/photoaddon.yml
web_extensions/photoaddon.yml with the init container config

Is there anything else needed for the deployment example?
Once I have clarity on these, I'll get the PR(s) ready. Thanks!

[LukasHirt]

Hello @paul43210 let me first also quickly say awesome job!

Regarding the move in general, I would like to let you know first that moving the extension into ownCloud repositories does not only involve changing the licence but also requires signing a licence agreement. I will attach the licence here so that you can see what it includes. The actual signing then happens in the first user's PR. It would also mean that all new contributions to these extensions would first need to go through review of ownCloud maintainers.

Licence

Version: 2016-08-04

Thank you for your interest in the open source software project ownCloud maintained or managed by ownCloud GmbH (“us” or “ownCloud”). The purpose of this Contribution Agreement (“Agreement”) is to define the intellectual property license granted by persons or entities that contribute code to us for the Project (“Contributions” and further defined below). If the Contribution is made on behalf of a company, the term “you” as used in this Agreement will mean the individual accepting this Agreement as well as the company employing such individual. You hereby agree to the following terms and conditions:

1. Contributions: The term “Contribution” means any source code, object code, patch, tool, sample, graphic, spe- cification, manual, documentation, or any other material posted or submitted by you to a Project. A Contribution is “submitted” when any form of electronic, verbal, or written communication is sent to the Project, in- cluding 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 Project for the purpose of discussing or improving software or docu- mentation of the Project. Communication that is conspicuously marked or designated in writing by you as “Not a Contribution” will not be considered a Contribution. Any Contribution submitted by you to the Project will be under the terms and conditions of this Agreement without any additional terms or conditions.
2. Grant of License: You hereby transfer to ownCloud your entire right, title, and interest (including all your rights un- der copyright) in the changes and enhancements to the Contribution, including changes in accompanying documenta- tion files and supporting files as well as changes in actual program code. The assignment shall also include any future revisions of these changes and enhancements hereafter made by you. This includes, at our option, the right to subli- cense these same rights to third parties through multiple levels of sublicensees or other licensing or transfer arrange- ments. You agree that you will not assert any moral rights in your contribution against us, our licensees or transferees. You also agree that we may register a copyright in the Contribution and exercise all ownership rights associated with it; and you agree that neither of us has any duty to consult with, obtain the consent of, pay or render an accounting to the other for any use or distribution of the Contribution. With respect to any patents you own, you hereby grant to ownCloud and to the recipients of software distributed by ownCloud a perpetual, irrevocable, non-exclusive, worldwide, full paid-up, royalty-free patent license to make, have made,use, offer to sell, sell, import, and otherwise transfer your Contribution in whole or in part, alone or in combination with or included in any product, work, derivative works or materials arising out of the Project, where such license applies only to those patent claims licensable by you that are necessarily infringed by your Contribution alone or by combination of your Contribution with the Project to which you submitted the Contribution. This license includes, at our option, the right to sublicense these same rights to third parties through multiple levels of sublicensees or other licensing or transfer arrangements.
3. Ownership: Except as set out above, you keep all right, title and interest in your Contribution. You represent that you are legally entitled to grant the above licenses. If your employer(s) has rights to intellectual property that you create that includes your Contribution, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the Pro- ject, or that your employer has executed a separate Contribution Agreement with us. You represent that your Contribution is an original work by you, and to your knowledge, no other person claims, or has the right to claim, any right whatsoever in the Contribution. You represent and warrant that to the best of your knowledge, each Contribution will not violate any third party's copy- rights, trademarks, patents, or other intellectual property rights.
4. Community pledge: ownCloud irrevocably confirms that any Contribution we received by you will at all times be made available under the terms of the Affero General Public License v3 (“AGPLv3” – for the “owncloud/core” repository), the terms of the General Public License v2 (“GPLv2” – for the “owncloud/mirall” and for the “owncloud/client” repository), the terms of the General Public License v2 (“GPLv2” – for the “owncloud/android” repository) or under the terms of the General Public License v3 (“GPLv3 – for the “ownCloud/iOS” repository).
5. Notice and Inclusion: You agree to notify us if you become aware of any circumstance which would make any of the foregoing representations inaccurate in any respect. The Project is under no obligation to accept and include every Contribution.
6. Effective Date: The rights that you grant to us under these terms are effective on the date you first submitted the Contribution to us, even if your submission took place before the date you sign these terms.

If you would prefer to avoid this, there is an alternative to make your extensions available and known to ownCloud users. We have got a https://github.com/owncloud/awesome-ocis/ repository where extensions can be added so that they are:

• visible to all users within the repository;
• loaded within the pre-bundled marketplace extension in oCIS.

If you would still like to proceed with adding this extension into this repository, here are answers to your previous questions:

Should photo-addon be added to the owncloud/web-extensions repo (under packages/web-app-photo-addon/), or would you prefer it stays as a standalone repo that gets published to the web-extensions Docker image?

It should be added directly into this repository using the path you mentioned and our CI/CD should be extended to build this extension as well.

I see existing extensions are at 0.3.2. Should I start photo-addon at 0.1.0, or align with the current version?

You should either use v0.1.0 (or a version that your extensions have currently set) without aligning to other extension versions.

The photo-addon loads external resources for its map view feature:
Leaflet.js from CDN
OpenStreetMap tiles from tile.openstreetmap.org
I'll need to include CSP configuration updates similar to how externalsites does. Should I add these to config/ocis/csp.yaml in the deployment example?

Yes, deployment example should be working out of the box so please, add any necessary configuration into it and also mention the required options in a readme/documentation. However, anything that can be loaded without reaching external resources is preferred so e.g. include leaflet.js if it could be installed via npm.

Should I create one PR to web-extensions with the extension code, then a separate PR to ocis for the deployment example updates or combine everything into a single PR?

Best to do it in separate PRs to limit the size of those PRs. It anyway needs to be done in separate PRs because the deployment example lives in oCIS repository though.

Is there anything else needed for the deployment example?

AFAICT steps you mentioned should be enough but this is best answered by @mmattel as he's the most knowledgable about the examples.

[mmattel]

@paul43210

Is there anything else needed for the deployment example?

If you take a look into the following link
https://github.com/owncloud/ocis/blob/master/deployments/examples/ocis_full/web_extensions/jsonviewer.yml
you see how a ready to deploy example (the jsonviewer) is setup. It consists of an entry in the ocis_full example and the real code referenced residing here. Therefore this approach is the most convenient way because anyone can use it immediately.

We also have a section in the admin docs for how to deploy ocis_full https://doc.owncloud.com/ocis/next/depl-examples/ubuntu-compose/ubuntu-compose-prod.html AND we care about this setup. Means we check if image updates keep the deployment in a working state and fix if not. This finally also finds its way into the release notes https://doc.owncloud.com/ocis_release_notes.html and migration/upgrade guide in the admin docs. Awsome-ocis does not have this setup. Note that we cant maintain your extension, but we can make it spread easily! But I think this is fair enough.

One note, any extension merges finally go into a ocis release when an extesion version is created and the version is updated in ocis_full. They are then also part of the versioned docs automatically. Additions/changes outside the ordinary release cycle can be made by creating a new extension version and adding it in ocis_full to the master branch. This is immediately reflected in the next release of the admin docs 😄

Let me/us know if you have more questions, you are welcomed!

[paul43210]

Thanks @mmattel and @LukasHirt for the detailed feedback and warm welcome! 🎉
I've reviewed the Contribution Agreement and will get that signed and sent over. Is there a PDF version i could sign?

Here's my plan based on your guidance:
For web-extensions repo (two separate PRs):

• PR 1: Add web-app-photo-addon under packages/web-app-photo-addon/
• PR 2: Add web-app-advanced-search under packages/web-app-advanced-search/
• Version both at v0.1.0
• License: AGPL-3.0
• Bundle Leaflet.js via npm instead of CDN
• Update .drone.star to include each extension
• Document CSP requirement for OpenStreetMap tiles (img-src: https://tile.openstreetmap.org) in the photo-addon README

For ocis repo (separate PRs):

• Add deployment examples following the jsonviewer.yml pattern
• Add .env entries for both extensions

Timeline:

• Backend PR #11912 just got approved by @kobergj and has auto-merge enabled 🚀
• I'll start working on the web-extensions PRs now

Thanks again for being so welcoming to a first-time contributor. Looking forward to getting these merged!

[paul43210]

PRs created:
#305
#306

[LukasHirt]

Thank you for outlining your plan @paul43210 ! I see you already signed the licence within your PR but just for completeness to answer your previous question:

I've reviewed the Contribution Agreement and will get that signed and sent over. Is there a PDF version i could sign?

Signing is handled within PRs via automated CLA assistant tool.