summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorThomas Müller <thomas.mueller@tmit.eu>2013-10-16 21:15:25 +0200
committerThomas Müller <thomas.mueller@tmit.eu>2013-10-16 21:15:25 +0200
commit221a650815800e47d6b2c9d7dfe0e9434ebc9edf (patch)
tree1da8fba37b07bbfd600f98039335a612c351972e /lib/public
parent852a50aa8968560738f61e32d8b1cb7f5cd329c1 (diff)
parent2fe9294c5d65e7e2264a8ddf10985bdd00c83a5a (diff)
downloadnextcloud-server-221a650815800e47d6b2c9d7dfe0e9434ebc9edf.tar.gz
nextcloud-server-221a650815800e47d6b2c9d7dfe0e9434ebc9edf.zip
Merge branch 'master' into activities-api
Conflicts: lib/private/server.php
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/appframework/app.php20
-rw-r--r--lib/public/appframework/controller.php145
-rw-r--r--lib/public/appframework/http/templateresponse.php18
-rw-r--r--lib/public/appframework/iapi.php73
-rw-r--r--lib/public/appframework/iappcontainer.php22
-rw-r--r--lib/public/appframework/middleware.php1
6 files changed, 180 insertions, 99 deletions
diff --git a/lib/public/appframework/app.php b/lib/public/appframework/app.php
index d97c5c81848..6ac48bf102a 100644
--- a/lib/public/appframework/app.php
+++ b/lib/public/appframework/app.php
@@ -31,8 +31,11 @@ namespace OCP\AppFramework;
* to be registered using IContainer::registerService
*/
class App {
- public function __construct($appName) {
- $this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName);
+ /**
+ * @param array $urlParams an array with variables extracted from the routes
+ */
+ public function __construct($appName, $urlParams = array()) {
+ $this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
}
private $container;
@@ -50,8 +53,8 @@ class App {
* Example code in routes.php of the task app:
* $this->create('tasks_index', '/')->get()->action(
* function($params){
- * $app = new TaskApp();
- * $app->dispatch('PageController', 'index', $params);
+ * $app = new TaskApp($params);
+ * $app->dispatch('PageController', 'index');
* }
* );
*
@@ -59,8 +62,8 @@ class App {
* Example for for TaskApp implementation:
* class TaskApp extends \OCP\AppFramework\App {
*
- * public function __construct(){
- * parent::__construct('tasks');
+ * public function __construct($params){
+ * parent::__construct('tasks', $params);
*
* $this->getContainer()->registerService('PageController', function(IAppContainer $c){
* $a = $c->query('API');
@@ -73,9 +76,8 @@ class App {
* @param string $controllerName the name of the controller under which it is
* stored in the DI container
* @param string $methodName the method that you want to call
- * @param array $urlParams an array with variables extracted from the routes
*/
- public function dispatch($controllerName, $methodName, array $urlParams) {
- \OC\AppFramework\App::main($controllerName, $methodName, $urlParams, $this->container);
+ public function dispatch($controllerName, $methodName) {
+ \OC\AppFramework\App::main($controllerName, $methodName, $this->container);
}
}
diff --git a/lib/public/appframework/controller.php b/lib/public/appframework/controller.php
new file mode 100644
index 00000000000..1642b508572
--- /dev/null
+++ b/lib/public/appframework/controller.php
@@ -0,0 +1,145 @@
+<?php
+
+/**
+ * ownCloud - App Framework
+ *
+ * @author Bernhard Posselt
+ * @copyright 2012 Bernhard Posselt nukeawhale@gmail.com
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+
+namespace OCP\AppFramework;
+
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\AppFramework\IAppContainer;
+use OCP\IRequest;
+
+
+/**
+ * Base class to inherit your controllers from
+ */
+abstract class Controller {
+
+ /**
+ * @var \OCP\AppFramework\IAppContainer
+ */
+ protected $app;
+
+ /**
+ * @var \OCP\IRequest
+ */
+ protected $request;
+
+ /**
+ * @param IAppContainer $app interface to the app
+ * @param IRequest $request an instance of the request
+ */
+ public function __construct(IAppContainer $app, IRequest $request){
+ $this->app = $app;
+ $this->request = $request;
+ }
+
+
+ /**
+ * Lets you access post and get parameters by the index
+ * @param string $key the key which you want to access in the URL Parameter
+ * placeholder, $_POST or $_GET array.
+ * The priority how they're returned is the following:
+ * 1. URL parameters
+ * 2. POST parameters
+ * 3. GET parameters
+ * @param mixed $default If the key is not found, this value will be returned
+ * @return mixed the content of the array
+ */
+ public function params($key, $default=null){
+ return $this->request->getParam($key, $default);
+ }
+
+
+ /**
+ * Returns all params that were received, be it from the request
+ * (as GET or POST) or throuh the URL by the route
+ * @return array the array with all parameters
+ */
+ public function getParams() {
+ return $this->request->getParams();
+ }
+
+
+ /**
+ * Returns the method of the request
+ * @return string the method of the request (POST, GET, etc)
+ */
+ public function method() {
+ return $this->request->getMethod();
+ }
+
+
+ /**
+ * Shortcut for accessing an uploaded file through the $_FILES array
+ * @param string $key the key that will be taken from the $_FILES array
+ * @return array the file in the $_FILES element
+ */
+ public function getUploadedFile($key) {
+ return $this->request->getUploadedFile($key);
+ }
+
+
+ /**
+ * Shortcut for getting env variables
+ * @param string $key the key that will be taken from the $_ENV array
+ * @return array the value in the $_ENV element
+ */
+ public function env($key) {
+ return $this->request->getEnv($key);
+ }
+
+
+ /**
+ * Shortcut for getting cookie variables
+ * @param string $key the key that will be taken from the $_COOKIE array
+ * @return array the value in the $_COOKIE element
+ */
+ public function cookie($key) {
+ return $this->request->getCookie($key);
+ }
+
+
+ /**
+ * Shortcut for rendering a template
+ * @param string $templateName the name of the template
+ * @param array $params the template parameters in key => value structure
+ * @param string $renderAs user renders a full page, blank only your template
+ * admin an entry in the admin settings
+ * @param array $headers set additional headers in name/value pairs
+ * @return \OCP\AppFramework\Http\TemplateResponse containing the page
+ */
+ public function render($templateName, array $params=array(),
+ $renderAs='user', array $headers=array()){
+ $response = new TemplateResponse($this->app->getAppName(), $templateName);
+ $response->setParams($params);
+ $response->renderAs($renderAs);
+
+ foreach($headers as $name => $value){
+ $response->addHeader($name, $value);
+ }
+
+ return $response;
+ }
+
+
+}
diff --git a/lib/public/appframework/http/templateresponse.php b/lib/public/appframework/http/templateresponse.php
index 97678c96cba..594530651aa 100644
--- a/lib/public/appframework/http/templateresponse.php
+++ b/lib/public/appframework/http/templateresponse.php
@@ -24,8 +24,6 @@
namespace OCP\AppFramework\Http;
-use OC\AppFramework\Core\API;
-
/**
* Response for a normal template
@@ -34,20 +32,16 @@ class TemplateResponse extends Response {
protected $templateName;
protected $params;
- protected $api;
protected $renderAs;
protected $appName;
/**
- * @param API $api an API instance
* @param string $templateName the name of the template
- * @param string $appName optional if you want to include a template from
- * a different app
+ * @param string $appName the name of the app to load the template from
*/
- public function __construct(API $api, $templateName, $appName=null) {
+ public function __construct($appName, $templateName) {
$this->templateName = $templateName;
$this->appName = $appName;
- $this->api = $api;
$this->params = array();
$this->renderAs = 'user';
}
@@ -108,13 +102,7 @@ class TemplateResponse extends Response {
*/
public function render(){
- if($this->appName !== null){
- $appName = $this->appName;
- } else {
- $appName = $this->api->getAppName();
- }
-
- $template = $this->api->getTemplate($this->templateName, $this->renderAs, $appName);
+ $template = new \OCP\Template($this->appName, $this->templateName, $this->renderAs);
foreach($this->params as $key => $value){
$template->assign($key, $value);
diff --git a/lib/public/appframework/iapi.php b/lib/public/appframework/iapi.php
index fa6af5f5965..3bde4c9d4e7 100644
--- a/lib/public/appframework/iapi.php
+++ b/lib/public/appframework/iapi.php
@@ -67,59 +67,6 @@ interface IApi {
*/
function add3rdPartyStyle($name);
- /**
- * Returns the translation object
- * @return \OC_L10N the translation object
- *
- * FIXME: returns private object / should be retrieved from teh ServerContainer
- */
- function getTrans();
-
-
- /**
- * Returns the URL for a route
- * @param string $routeName the name of the route
- * @param array $arguments an array with arguments which will be filled into the url
- * @return string the url
- */
- function linkToRoute($routeName, $arguments=array());
-
-
- /**
- * Returns an URL for an image or file
- * @param string $file the name of the file
- * @param string $appName the name of the app, defaults to the current one
- */
- function linkTo($file, $appName=null);
-
-
- /**
- * Returns the link to an image, like link to but only with prepending img/
- * @param string $file the name of the file
- * @param string $appName the name of the app, defaults to the current one
- */
- function imagePath($file, $appName = null);
-
-
- /**
- * Makes an URL absolute
- * @param string $url the url
- * @return string the absolute url
- *
- * FIXME: function should live in Request / Response
- */
- function getAbsoluteURL($url);
-
-
- /**
- * links to a file
- * @param string $file the name of the file
- * @param string $appName the name of the app, defaults to the current one
- * @deprecated replaced with linkToRoute()
- * @return string the url
- */
- function linkToAbsolute($file, $appName = null);
-
/**
* Checks if an app is enabled
@@ -128,24 +75,4 @@ interface IApi {
*/
public function isAppEnabled($appName);
-
- /**
- * Writes a function into the error log
- * @param string $msg the error message to be logged
- * @param int $level the error level
- *
- * FIXME: add logger instance to ServerContainer
- */
- function log($msg, $level = null);
-
-
- /**
- * Returns a template
- * @param string $templateName the name of the template
- * @param string $renderAs how it should be rendered
- * @param string $appName the name of the app
- * @return \OCP\Template a new template
- */
- function getTemplate($templateName, $renderAs='user', $appName=null);
-
}
diff --git a/lib/public/appframework/iappcontainer.php b/lib/public/appframework/iappcontainer.php
index 7d3b4b3bac7..7e6ec6016b7 100644
--- a/lib/public/appframework/iappcontainer.php
+++ b/lib/public/appframework/iappcontainer.php
@@ -50,8 +50,26 @@ interface IAppContainer extends IContainer{
function getServer();
/**
- * @param IMiddleWare $middleWare
+ * @param Middleware $middleWare
* @return boolean
*/
- function registerMiddleWare(IMiddleWare $middleWare);
+ function registerMiddleWare(Middleware $middleWare);
+
+ /**
+ * @return boolean
+ */
+ function isLoggedIn();
+
+ /**
+ * @return boolean
+ */
+ function isAdminUser();
+
+ /**
+ * @param $message
+ * @param $level
+ * @return mixed
+ */
+ function log($message, $level);
+
}
diff --git a/lib/public/appframework/middleware.php b/lib/public/appframework/middleware.php
index 12776c119c0..94f71ea8520 100644
--- a/lib/public/appframework/middleware.php
+++ b/lib/public/appframework/middleware.php
@@ -24,6 +24,7 @@
namespace OCP\AppFramework;
+use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\Response;