summaryrefslogtreecommitdiffstats
path: root/apps/updatenotification
diff options
context:
space:
mode:
authorLukas Reschke <lukas@owncloud.com>2016-02-09 13:06:48 +0100
committerLukas Reschke <lukas@owncloud.com>2016-02-09 18:05:51 +0100
commitabc675d87e6ffc49fad608d5b2e8d280e385cc61 (patch)
tree558a752af5c3d9936cbd597ea76607f57e22c32c /apps/updatenotification
parent29820176825c41acef30fa6942922aeb36cfcec3 (diff)
downloadnextcloud-server-abc675d87e6ffc49fad608d5b2e8d280e385cc61.tar.gz
nextcloud-server-abc675d87e6ffc49fad608d5b2e8d280e385cc61.zip
Move update notification code into app
Moves the update notification code in a single app. This is required since we want to use SSO for the new updater and for this have some code running in ownCloud as well (and we don't want that in core neccessarily). This app can provide that in the future, right now it's only the update notification itself. Will continue working on the SSO right away but wanted to keep the PR small. Furthermore also makes some more code unit-testable...
Diffstat (limited to 'apps/updatenotification')
-rw-r--r--apps/updatenotification/appinfo/app.php39
-rw-r--r--apps/updatenotification/appinfo/info.xml13
-rw-r--r--apps/updatenotification/js/notification.js30
-rw-r--r--apps/updatenotification/lib/updatechecker.php67
-rw-r--r--apps/updatenotification/tests/UpdateCheckerTest.php86
5 files changed, 235 insertions, 0 deletions
diff --git a/apps/updatenotification/appinfo/app.php b/apps/updatenotification/appinfo/app.php
new file mode 100644
index 00000000000..d5e973be528
--- /dev/null
+++ b/apps/updatenotification/appinfo/app.php
@@ -0,0 +1,39 @@
+<?php
+/**
+ * @author Lukas Reschke <lukas@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+if(\OC::$server->getConfig()->getSystemValue('updatechecker', true) === true) {
+ $updater = new \OC\Updater(
+ \OC::$server->getHTTPHelper(),
+ \OC::$server->getConfig(),
+ \OC::$server->getIntegrityCodeChecker()
+ );
+ $updateChecker = new \OCA\UpdateNotification\UpdateChecker(
+ $updater
+ );
+
+ $userObject = \OC::$server->getUserSession()->getUser();
+ if($userObject !== null) {
+ if(\OC::$server->getGroupManager()->isAdmin($userObject->getUID()) && $updateChecker->getUpdateState() !== []) {
+ \OCP\Util::addScript('updatenotification', 'notification');
+ OC_Hook::connect('\OCP\Config', 'js', $updateChecker, 'getJavaScript');
+ }
+ }
+}
diff --git a/apps/updatenotification/appinfo/info.xml b/apps/updatenotification/appinfo/info.xml
new file mode 100644
index 00000000000..0bfdd861a2f
--- /dev/null
+++ b/apps/updatenotification/appinfo/info.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<info>
+ <id>updatenotification</id>
+ <name>Update notification</name>
+ <description>Displays update notifications for ownCloud.</description>
+ <licence>AGPL</licence>
+ <author>Lukas Reschke</author>
+ <version>0.1.0</version>
+ <default_enable/>
+ <dependencies>
+ <owncloud min-version="9.0" max-version="9.0" />
+ </dependencies>
+</info>
diff --git a/apps/updatenotification/js/notification.js b/apps/updatenotification/js/notification.js
new file mode 100644
index 00000000000..9d22bcb2309
--- /dev/null
+++ b/apps/updatenotification/js/notification.js
@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2015 ownCloud Inc
+ *
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * This file is licensed under the Affero General Public License version 3
+ * or later.
+ *
+ * See the COPYING-README file.
+ *
+ */
+
+/**
+ * this gets only loaded if an update is available and then shows a temporary notification
+ */
+$(document).ready(function(){
+ var head = $('html > head'),
+ version = oc_updateState.updateVersion,
+ docLink = oc_updateState.updateLink,
+ text = t('core', '{version} is available. Get more information on how to update.', {version: version}),
+ element = $('<a>').attr('href', docLink).text(text);
+
+ OC.Notification.showTemporary(
+ element,
+ {
+ isHTML: true
+ }
+ );
+});
+
diff --git a/apps/updatenotification/lib/updatechecker.php b/apps/updatenotification/lib/updatechecker.php
new file mode 100644
index 00000000000..965e21617e7
--- /dev/null
+++ b/apps/updatenotification/lib/updatechecker.php
@@ -0,0 +1,67 @@
+<?php
+/**
+ * @author Lukas Reschke <lukas@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\UpdateNotification;
+
+use OC\Updater;
+
+class UpdateChecker {
+ /** @var Updater */
+ private $updater;
+
+ /**
+ * @param Updater $updater
+ */
+ public function __construct(Updater $updater) {
+ $this->updater = $updater;
+ }
+
+ /**
+ * @return array
+ */
+ public function getUpdateState() {
+ $data = $this->updater->check();
+ $result = [];
+
+ if(isset($data['version']) && $data['version'] !== '' && $data['version'] !== []) {
+ $result['updateAvailable'] = true;
+ $result['updateVersion'] = $data['versionstring'];
+ if(substr($data['web'], 0, 8) === 'https://') {
+ $result['updateLink'] = $data['web'];
+ }
+
+ return $result;
+ }
+
+ return [];
+ }
+
+ /**
+ * @param array $data
+ */
+ public function getJavaScript(array $data) {
+ $data['array']['oc_updateState'] = json_encode([
+ 'updateAvailable' => true,
+ 'updateVersion' => $this->getUpdateState()['updateVersion'],
+ 'updateLink' => isset($this->getUpdateState()['updateLink']) ? $this->getUpdateState()['updateLink'] : '',
+ ]);
+ }
+}
diff --git a/apps/updatenotification/tests/UpdateCheckerTest.php b/apps/updatenotification/tests/UpdateCheckerTest.php
new file mode 100644
index 00000000000..9591758c4c9
--- /dev/null
+++ b/apps/updatenotification/tests/UpdateCheckerTest.php
@@ -0,0 +1,86 @@
+<?php
+/**
+ * @author Lukas Reschke <lukas@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\UpdateNotification\Tests;
+
+use OC\Updater;
+use OCA\UpdateNotification\UpdateChecker;
+use Test\TestCase;
+
+class UpdateCheckerTest extends TestCase {
+ /** @var Updater */
+ private $updater;
+ /** @var UpdateChecker */
+ private $updateChecker;
+
+ public function setUp() {
+ parent::setUp();
+
+ $this->updater = $this->getMockBuilder('\OC\Updater')
+ ->disableOriginalConstructor()->getMock();
+ $this->updateChecker = new UpdateChecker($this->updater);
+ }
+
+ public function testGetUpdateStateWithUpdateAndInvalidLink() {
+ $this->updater
+ ->expects($this->once())
+ ->method('check')
+ ->willReturn([
+ 'version' => 123,
+ 'versionstring' => 'ownCloud 123',
+ 'web'=> 'javascript:alert(1)',
+ ]);
+
+ $expected = [
+ 'updateAvailable' => true,
+ 'updateVersion' => 'ownCloud 123',
+ ];
+ $this->assertSame($expected, $this->updateChecker->getUpdateState());
+ }
+
+ public function testGetUpdateStateWithUpdateAndValidLink() {
+ $this->updater
+ ->expects($this->once())
+ ->method('check')
+ ->willReturn([
+ 'version' => 123,
+ 'versionstring' => 'ownCloud 123',
+ 'web'=> 'https://owncloud.org/myUrl',
+ ]);
+
+ $expected = [
+ 'updateAvailable' => true,
+ 'updateVersion' => 'ownCloud 123',
+ 'updateLink' => 'https://owncloud.org/myUrl',
+ ];
+ $this->assertSame($expected, $this->updateChecker->getUpdateState());
+ }
+
+ public function testGetUpdateStateWithoutUpdate() {
+ $this->updater
+ ->expects($this->once())
+ ->method('check')
+ ->willReturn([]);
+
+ $expected = [];
+ $this->assertSame($expected, $this->updateChecker->getUpdateState());
+ }
+}