Initial commit

.gitignore

@@ -0,0 +1,3 @@
+.idea
+vendor
+build

.travis.yml

@@ -0,0 +1,64 @@
+sudo: false
+dist: trusty
+language: php
+php:
+    - 5.6
+    - 7
+    - 7.1
+env:
+    global:
+        - CORE_BRANCH=stable15
+    matrix:
+        - DB=pgsql
+
+matrix:
+    allow_failures:
+        - env: DB=pgsql CORE_BRANCH=master
+    include:
+        - php: 5.6
+          env: DB=sqlite
+        - php: 5.6
+          env: DB=mysql
+        - php: 5.6
+          env: DB=pgsql CORE_BRANCH=master
+    fast_finish: true
+
+
+before_install:
+    # enable a display for running JavaScript tests
+    - export DISPLAY=:99.0
+    - sh -e /etc/init.d/xvfb start
+    - nvm install 8
+    - npm install -g npm@latest
+    - make
+    - make appstore
+    # install core
+    - cd ../
+    - git clone https://github.com/nextcloud/server.git --recursive --depth 1 -b $CORE_BRANCH nextcloud
+    - mv "$TRAVIS_BUILD_DIR" nextcloud/apps/storj
+
+before_script:
+    - if [[ "$DB" == 'pgsql' ]]; then createuser -U travis -s oc_autotest; fi
+    - if [[ "$DB" == 'mysql' ]]; then mysql -u root -e 'create database oc_autotest;'; fi
+    - if [[ "$DB" == 'mysql' ]]; then mysql -u root -e "CREATE USER 'oc_autotest'@'localhost' IDENTIFIED BY '';"; fi
+    - if [[ "$DB" == 'mysql' ]]; then mysql -u root -e "grant all on oc_autotest.* to 'oc_autotest'@'localhost';"; fi
+    - cd nextcloud
+    - mkdir data
+    - ./occ maintenance:install --database-name oc_autotest --database-user oc_autotest --admin-user admin --admin-pass admin --database $DB --database-pass=''
+    - ./occ app:enable storj
+    - php -S localhost:8080 &
+    - cd apps/storj
+
+script:
+    - make test
+
+after_failure:
+    - cat ../../data/nextcloud.log
+
+addons:
+    firefox: 'latest'
+    mariadb: '10.1'
+
+services:
+  - postgresql
+  - mariadb

CHANGELOG.md

@@ -0,0 +1,3 @@
+## [Unreleased]
+### Added
+- Initial version

Makefile

@@ -0,0 +1,156 @@
+# This file is licensed under the Affero General Public License version 3 or
+# later. See the COPYING file.
+# @author Bernhard Posselt <[email protected]>
+# @copyright Bernhard Posselt 2016
+
+# Generic Makefile for building and packaging a Nextcloud app which uses npm and
+# Composer.
+#
+# Dependencies:
+# * make
+# * which
+# * curl: used if phpunit and composer are not installed to fetch them from the web
+# * tar: for building the archive
+# * npm: for building and testing everything JS
+#
+# If no composer.json is in the app root directory, the Composer step
+# will be skipped. The same goes for the package.json which can be located in
+# the app root or the js/ directory.
+#
+# The npm command by launches the npm build script:
+#
+#    npm run build
+#
+# The npm test command launches the npm test script:
+#
+#    npm run test
+#
+# The idea behind this is to be completely testing and build tool agnostic. All
+# build tools and additional package managers should be installed locally in
+# your project, since this won't pollute people's global namespace.
+#
+# The following npm scripts in your package.json install and update the bower
+# and npm dependencies and use gulp as build system (notice how everything is
+# run from the node_modules folder):
+#
+#    "scripts": {
+#        "test": "node node_modules/gulp-cli/bin/gulp.js karma",
+#        "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
+#        "build": "node node_modules/gulp-cli/bin/gulp.js"
+#    },
+
+app_name=$(notdir $(CURDIR))
+build_tools_directory=$(CURDIR)/build/tools
+source_build_directory=$(CURDIR)/build/artifacts/source
+source_package_name=$(source_build_directory)/$(app_name)
+appstore_build_directory=$(CURDIR)/build/artifacts/appstore
+appstore_package_name=$(appstore_build_directory)/$(app_name)
+npm=$(shell which npm 2> /dev/null)
+composer=$(shell which composer 2> /dev/null)
+
+all: build
+
+# Fetches the PHP and JS dependencies and compiles the JS. If no composer.json
+# is present, the composer step is skipped, if no package.json or js/package.json
+# is present, the npm step is skipped
+.PHONY: build
+build:
+ifneq (,$(wildcard $(CURDIR)/composer.json))
+	make composer
+endif
+ifneq (,$(wildcard $(CURDIR)/package.json))
+	make npm
+endif
+ifneq (,$(wildcard $(CURDIR)/js/package.json))
+	make npm
+endif
+
+# Installs and updates the composer dependencies. If composer is not installed
+# a copy is fetched from the web
+.PHONY: composer
+composer:
+ifeq (, $(composer))
+	@echo "No composer command available, downloading a copy from the web"
+	mkdir -p $(build_tools_directory)
+	curl -sS https://getcomposer.org/installer | php
+	mv composer.phar $(build_tools_directory)
+	php $(build_tools_directory)/composer.phar install --prefer-dist
+else
+	composer install --prefer-dist
+endif
+
+# Installs npm dependencies
+.PHONY: npm
+npm:
+ifeq (,$(wildcard $(CURDIR)/package.json))
+	cd js && $(npm) run build
+else
+	npm run build
+endif
+
+# Removes the appstore build
+.PHONY: clean
+clean:
+	rm -rf ./build
+
+# Same as clean but also removes dependencies installed by composer, bower and
+# npm
+.PHONY: distclean
+distclean: clean
+	rm -rf vendor
+	rm -rf node_modules
+	rm -rf js/vendor
+	rm -rf js/node_modules
+
+# Builds the source and appstore package
+.PHONY: dist
+dist:
+	make source
+	make appstore
+
+# Builds the source package
+.PHONY: source
+source:
+	rm -rf $(source_build_directory)
+	mkdir -p $(source_build_directory)
+	tar cvzf $(source_package_name).tar.gz ../$(app_name) \
+	--exclude-vcs \
+	--exclude="../$(app_name)/build" \
+	--exclude="../$(app_name)/js/node_modules" \
+	--exclude="../$(app_name)/node_modules" \
+	--exclude="../$(app_name)/*.log" \
+	--exclude="../$(app_name)/js/*.log" \
+
+# Builds the source package for the app store, ignores php and js tests
+.PHONY: appstore
+appstore:
+	rm -rf $(appstore_build_directory)
+	mkdir -p $(appstore_build_directory)
+	tar cvzf $(appstore_package_name).tar.gz \
+	--exclude="../$(app_name)/build" \
+	--exclude-vcs \
+	--exclude="../$(app_name)/tests" \
+	--exclude="../$(app_name)/Makefile" \
+	--exclude="../$(app_name)/*.log" \
+	--exclude="../$(app_name)/phpunit*xml" \
+	--exclude="../$(app_name)/composer.*" \
+	--exclude="../$(app_name)/js/node_modules" \
+	--exclude="../$(app_name)/js/tests" \
+	--exclude="../$(app_name)/js/test" \
+	--exclude="../$(app_name)/js/*.log" \
+	--exclude="../$(app_name)/js/package.json" \
+	--exclude="../$(app_name)/js/bower.json" \
+	--exclude="../$(app_name)/js/karma.*" \
+	--exclude="../$(app_name)/js/protractor.*" \
+	--exclude="../$(app_name)/package.json" \
+	--exclude="../$(app_name)/bower.json" \
+	--exclude="../$(app_name)/karma.*" \
+	--exclude="../$(app_name)/protractor\.*" \
+	--exclude="../$(app_name)/.*" \
+	--exclude="../$(app_name)/js/.*" \
+	../$(app_name)
+
+.PHONY: test
+test: composer
+	$(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.xml
+	$(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.integration.xml

README.md

@@ -0,0 +1,78 @@
+# Storj NextCloud App
+
+**EXPERIMENTAL**
+
+A Storj Community contributed decentralized storage backend for Nextcloud built on Storj DCS.
+
+## Prerequisites
+
+The PHP installation should have the FFI extension loaded and enabled unconditionally in php.ini:
+
+```
+extension=ffi
+
+ffi.enable=true
+```
+
+## Installation
+
+Install from the app store or place this app in the folder `apps` of the nextcloud installation
+
+## Configuration
+
+Storj works like any external object storage. See the documentation on docs.nextcloud.com:
+
+* [Configuring Object Storage as Primary Storage](https://docs.nextcloud.com/server/20/admin_manual/configuration_files/primary_storage.html)
+* [Configuring External Storage (GUI)](https://docs.nextcloud.com/server/20/admin_manual/configuration_files/external_storage_configuration_gui.html)
+
+This is the configuration to set Storj as your primary storage:
+
+```php
+$CONFIG = [
+    'objectstore' => [
+        'class' => \OCA\Storj\StorjObjectStore::class,
+        'arguments' => [
+            'serialized_access' => 'myaccessgrant',
+            'bucket' => 'mynextcloudbucket',
+        ]
+    ]
+];
+```
+
+Primary storage is more responsive.
+
+## Building
+
+The app can be built by using the provided Makefile by running:
+
+    make
+
+## Publish to App Store
+
+First get an account for the [App Store](http://apps.nextcloud.com/) then run:
+
+    make && make appstore
+
+The archive is located in build/artifacts/appstore and can then be uploaded to the App Store.
+
+## Running tests
+You can use the provided Makefile to run all tests by using:
+
+    make test
+
+This will run the PHP unit and integration tests and if a package.json is present in the **js/** folder will execute **npm run test**
+
+Of course you can also install [PHPUnit](http://phpunit.de/getting-started.html) and use the configurations directly:
+
+    phpunit -c phpunit.xml
+
+or:
+
+    phpunit -c phpunit.integration.xml
+
+for integration tests
+
+## Known issues and improvements
+
+- Using external storage is slower than necessary because NextCloud request objects metadata separately during the same HTTP request. This can be improved by caching the results at the initial list operation. 
+- Under unknown circumstances a segfault seems to occur.

appinfo/info.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<info xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="https://apps.nextcloud.com/schema/apps/info.xsd">
+    <id>storj</id>
+    <name>Storj</name>
+    <summary>Storage backend built on Storj DCS.</summary>
+    <description><![CDATA[A Storj Community contributed decentralized storage backend for Nextcloud built on Storj DCS.]]></description>
+    <version>0.0.1</version>
+    <licence>agpl</licence>
+    <author mail="[email protected]" homepage="https://github.com/erikvv">Erik van Velzen</author>
+    <namespace>Storj</namespace>
+    <category>files</category>
+    <category>integration</category>
+    <bugs>https://github.com/storj-thirdparty/nextcloud-app/issues</bugs>
+    <dependencies>
+        <nextcloud min-version="20" max-version="22"/>
+    </dependencies>
+    <navigations>
+    </navigations>
+</info>

appinfo/routes.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * Create your routes in here. The name is the lowercase name of the controller
+ * without the controller part, the stuff after the hash is the method.
+ * e.g. page#index -> OCA\Storj\Controller\PageController->index()
+ *
+ * The controller class has to be registered in the application.php file since
+ * it's instantiated in there
+ */
+return [
+    'routes' => [
+    ]
+];

composer.json

@@ -0,0 +1,49 @@
+{
+    "name": "erikvv/storj",
+    "description": "Distributed storage on the Storj network",
+    "type": "project",
+    "license": "AGPL",
+    "authors": [
+        {
+            "name": "Erik van Velzen"
+        }
+    ],
+    "require": {
+        "storj/uplink": "^0.1.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.5"
+    },
+    "repositories": {
+        "storj/uplink": {
+            "type": "package",
+            "package": {
+                "name": "storj/uplink",
+                "version": "0.1.0",
+                "license": "MIT/Expat",
+                "dist": {
+                    "url": "https://github.com/storj-thirdparty/uplink-php/releases/download/v0.1.0/release.zip",
+                    "type": "zip"
+                },
+                "autoload": {
+                    "psr-4": {
+                        "Storj\\Uplink\\": "src/"
+                    }
+                },
+                "autoload-dev": {
+                    "psr-4": {
+                        "Storj\\Uplink\\Test\\": "test/"
+                    }
+                },
+                "require": {
+                    "php": ">=7.4",
+                    "ext-ffi": "*",
+                    "psr/http-message": "^1.0"
+                },
+                "require-dev": {
+                    "phpunit/phpunit": "^9.2"
+                }
+            }
+        }
+    }
+}