Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
raphj committed Jan 4, 2023
0 parents commit 462ac0f
Show file tree
Hide file tree
Showing 46 changed files with 18,556 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
extends: [
'@nextcloud',
]
}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/js
/node_modules
/vendor
64 changes: 64 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
sudo: false
dist: trusty
language: php
php:
- 5.6
- 7
- 7.1
env:
global:
- CORE_BRANCH=stable12
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/xwiki

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 xwiki
- php -S localhost:8080 &
- cd apps/xwiki

script:
- make test

after_failure:
- cat ../../data/nextcloud.log

addons:
firefox: 'latest'
mariadb: '10.1'

services:
- postgresql
- mariadb
661 changes: 661 additions & 0 deletions COPYING

Large diffs are not rendered by default.

162 changes: 162 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# 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)/vendor" \
--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-vcs \
--exclude="../$(app_name)/build" \
--exclude="../$(app_name)/tests" \
--exclude="../$(app_name)/Makefile" \
--exclude="../$(app_name)/*.log" \
--exclude="../$(app_name)/phpunit*xml" \
--exclude="../$(app_name)/composer.*" \
--exclude="../$(app_name)/vendor" \
--exclude="../$(app_name)/node_modules" \
--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)/package-lock.json" \
--exclude="../$(app_name)/bower.json" \
--exclude="../$(app_name)/*.config.js" \
--exclude="../$(app_name)/karma.*" \
--exclude="../$(app_name)/protractor\.*" \
--exclude="../$(app_name)/doc" \
--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
77 changes: 77 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# XWiki Application for Nextcloud

## Introduction

This application integrates Nextcloud with XWiki. It allows users to search
and display XWiki content from Nextcloud.

Administrators add wikis that can be used from Nextcloud, and users
login to these wikis from Nextcloud so they can see content only they can
access.

The XWiki extension [Nextcloud Application](https://github.com/xwiki-contrib/application-nextcloud) should be installed on these wikis.
This will allow users to login to these instances from Nextcloud. If the
extension is not installed, users will only be able to search and display
contents available to guests.

### Search

![Search XWiki Content from Nextcloud](doc/search.png)

### Browsing XWiki Content (experimental)

![Browsing XWiki Content from Nextcloud](doc/browse.mp4)

## Installation (for developers)

Place this app in **nextcloud/apps/**

## Building the app

The app can be built by using the provided Makefile by running:

make

This requires the following things to be present:
* make
* which
* tar: for building the archive
* curl: used if phpunit and composer are not installed to fetch them from the web
* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder

The make command will install or update Composer dependencies if a composer.json is present and also **npm run build** if a package.json is present in the **js/** folder. The npm **build** script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.:

**package.json**:
```json
"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"
}
```


## 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
29 changes: 29 additions & 0 deletions appinfo/info.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?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>xwiki</id>
<name>XWiki</name>
<summary>XWiki Integration for Nextcloud</summary>
<description><![CDATA[XWiki is a light and powerful development platform that allows you to customize the wiki to your specific needs. Using structured data and in-page-scripting you can create macros and applications that allow you to extend the capabilities of your wiki.]]></description>
<version>0.0.1</version>
<licence>agpl</licence>
<author mail="[email protected]" homepage="https://xwiki.org">Raphaël Jakse</author>
<category>integration</category>
<bugs>https://jira.xwiki.org/</bugs>
<dependencies>
<php min-version="8.0"/>
<nextcloud min-version="25" max-version="26"/>
</dependencies>
<navigations>
<navigation>
<name>XWiki</name>
<route>xwiki.page.index</route>
</navigation>
</navigations>
<settings>
<admin>OCA\Xwiki\Settings\Admin</admin>
<admin-section>OCA\Xwiki\Settings\AdminSection</admin-section>
<personal>OCA\Xwiki\Settings\User</personal>
<personal-section>OCA\Xwiki\Settings\UserSection</personal-section>
</settings>
</info>
19 changes: 19 additions & 0 deletions appinfo/routes.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

namespace OCA\Xwiki\AppInfo;

return [
'routes' => [
['name' => 'page#index', 'url' => '/', 'verb' => 'GET'],
['name' => 'page#savePDF', 'url' => '/savePDF', 'verb' => 'POST'],
['name' => 'settings#deleteToken', 'url' => 'settings/deleteToken', 'verb' => 'POST'],
['name' => 'settings#addToken', 'url' => 'settings/addToken', 'verb' => 'POST'],
['name' => 'settings#requestToken', 'url' => 'settings/requestToken', 'verb' => 'GET'],
['name' => 'settings#oidcRedirect', 'url' => 'settings/oidcRedirect', 'verb' => 'GET'],
['name' => 'settings#addInstance', 'url' => 'settings/addInstance', 'verb' => 'POST'],
['name' => 'settings#setUserValue', 'url' => 'settings/setUserValue', 'verb' => 'POST'],
['name' => 'settings#replaceInstance', 'url' => 'settings/replaceInstance', 'verb' => 'POST'],
['name' => 'settings#deleteInstance', 'url' => 'settings/deleteInstance', 'verb' => 'POST'],
['name' => 'settings#pingInstance', 'url' => 'settings/pingInstance', 'verb' => 'GET'],
]
];
9 changes: 9 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
const babelConfig = require('@nextcloud/babel-config')

for (const preset of babelConfig.presets) {
if (preset[0] === '@babel/preset-env') {
preset[1].exclude = ['transform-regenerator', 'transform-async-to-generator', 'transform-for-of']
}
}
babelConfig.presets.push("@babel/preset-typescript");
module.exports = babelConfig
15 changes: 15 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "nextcloud/xwiki",
"description": "XWiki Integration for Nextcloud",
"type": "project",
"license": "AGPL",
"authors": [
{
"name": "Raphaël Jakse"
}
],
"require": {},
"require-dev": {
"phpunit/phpunit": "^9"
}
}
Loading

0 comments on commit 462ac0f

Please sign in to comment.