nextcloud/lib/ocsclient.php

265 lines
7.5 KiB
PHP
Raw Normal View History

2011-04-16 16:36:32 +04:00
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
2012-05-26 21:14:24 +04:00
* @copyright 2012 Frank Karlitschek frank@owncloud.org
2011-04-16 16:36:32 +04:00
*
* 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/>.
*
*/
/**
* This class provides an easy way for apps to store config values in the
* database.
*/
2011-07-29 23:36:03 +04:00
class OC_OCSClient{
2011-04-16 16:36:32 +04:00
/**
2012-08-29 10:38:33 +04:00
* @brief Get the url of the OCS AppStore server.
* @returns string of the AppStore server
*
* This function returns the url of the OCS AppStore server. It´s possible to set it in the config file or it will fallback to the default
*/
2012-09-07 17:22:01 +04:00
private static function getAppStoreURL() {
$url = OC_Config::getValue('appstoreurl', 'http://api.apps.owncloud.com/v1');
return($url);
}
/**
2012-08-29 10:38:33 +04:00
* @brief Get the url of the OCS KB server.
* @returns string of the KB server
* This function returns the url of the OCS knowledge base server. It´s possible to set it in the config file or it will fallback to the default
*/
2012-09-07 17:22:01 +04:00
private static function getKBURL() {
$url = OC_Config::getValue('knowledgebaseurl', 'http://api.apps.owncloud.com/v1');
return($url);
}
/**
* @brief Get the content of an OCS url call.
* @returns string of the response
* This function calls an OCS server and returns the response. It also sets a sane timeout
*/
private static function getOCSresponse($url) {
// set a sensible timeout of 10 sec to stay responsive even if the server is down.
$ctx = stream_context_create(
array(
'http' => array(
'timeout' => 10
)
)
);
$data=@file_get_contents($url, 0, $ctx);
return($data);
}
2011-04-16 16:36:32 +04:00
/**
* @brief Get all the categories from the OCS server
* @returns array with category ids
* @note returns NULL if config value appstoreenabled is set to false
2011-04-16 16:36:32 +04:00
* This function returns a list of all the application categories on the OCS server
*/
2012-09-07 17:22:01 +04:00
public static function getCategories() {
if(OC_Config::getValue('appstoreenabled', true)==false) {
return NULL;
}
$url=OC_OCSClient::getAppStoreURL().'/content/categories';
$xml=OC_OCSClient::getOCSresponse($url);
2012-09-07 17:22:01 +04:00
if($xml==FALSE) {
2011-06-19 00:02:45 +04:00
return NULL;
}
$data=simplexml_load_string($xml);
2012-08-29 10:38:33 +04:00
2011-04-17 18:04:46 +04:00
$tmp=$data->data;
2011-04-17 01:07:18 +04:00
$cats=array();
2011-04-17 18:04:46 +04:00
2012-07-20 19:51:50 +04:00
foreach($tmp->category as $value) {
2011-04-17 18:04:46 +04:00
$id= (int) $value->id;
$name= (string) $value->name;
$cats[$id]=$name;
}
2011-04-17 18:04:46 +04:00
return $cats;
2011-04-16 16:36:32 +04:00
}
/**
* @brief Get all the applications from the OCS server
* @returns array with application data
*
* This function returns a list of all the applications on the OCS server
*/
2012-09-07 17:22:01 +04:00
public static function getApplications($categories,$page,$filter) {
if(OC_Config::getValue('appstoreenabled', true)==false) {
return(array());
}
2011-06-19 00:02:45 +04:00
if(is_array($categories)) {
2011-04-17 01:07:18 +04:00
$categoriesstring=implode('x',$categories);
}else{
$categoriesstring=$categories;
}
$version='&version='.implode('x',\OC_Util::getVersion());
$filterurl='&filter='.urlencode($filter);
$url=OC_OCSClient::getAppStoreURL().'/content/data?categories='.urlencode($categoriesstring).'&sortmode=new&page='.urlencode($page).'&pagesize=100'.$filterurl.$version;
$apps=array();
$xml=OC_OCSClient::getOCSresponse($url);
2012-09-07 17:22:01 +04:00
if($xml==FALSE) {
2011-06-19 00:02:45 +04:00
return NULL;
}
$data=simplexml_load_string($xml);
2011-06-19 00:02:45 +04:00
$tmp=$data->data->content;
for($i = 0; $i < count($tmp); $i++) {
$app=array();
2011-08-11 17:11:06 +04:00
$app['id']=(string)$tmp[$i]->id;
$app['name']=(string)$tmp[$i]->name;
$app['type']=(string)$tmp[$i]->typeid;
$app['typename']=(string)$tmp[$i]->typename;
$app['personid']=(string)$tmp[$i]->personid;
2011-08-28 01:56:22 +04:00
$app['license']=(string)$tmp[$i]->license;
2011-08-11 17:11:06 +04:00
$app['detailpage']=(string)$tmp[$i]->detailpage;
$app['preview']=(string)$tmp[$i]->smallpreviewpic1;
$app['changed']=strtotime($tmp[$i]->changed);
2011-08-11 17:11:06 +04:00
$app['description']=(string)$tmp[$i]->description;
$app['score']=(string)$tmp[$i]->score;
2012-08-29 10:38:33 +04:00
$apps[]=$app;
2012-08-29 10:38:33 +04:00
}
return $apps;
2011-04-16 16:36:32 +04:00
}
2011-04-17 01:07:18 +04:00
2011-06-19 00:02:45 +04:00
/**
* @brief Get an the applications from the OCS server
* @returns array with application data
*
* This function returns an applications from the OCS server
*/
2012-09-07 17:22:01 +04:00
public static function getApplication($id) {
if(OC_Config::getValue('appstoreenabled', true)==false) {
return NULL;
}
$url=OC_OCSClient::getAppStoreURL().'/content/data/'.urlencode($id);
$xml=OC_OCSClient::getOCSresponse($url);
2011-06-19 00:02:45 +04:00
2012-09-07 17:22:01 +04:00
if($xml==FALSE) {
OC_Log::write('core','Unable to parse OCS content',OC_Log::FATAL);
2011-06-19 00:02:45 +04:00
return NULL;
}
$data=simplexml_load_string($xml);
$tmp=$data->data->content;
$app=array();
$app['id']=$tmp->id;
$app['name']=$tmp->name;
$app['type']=$tmp->typeid;
$app['typename']=$tmp->typename;
$app['personid']=$tmp->personid;
$app['detailpage']=$tmp->detailpage;
$app['preview1']=$tmp->smallpreviewpic1;
$app['preview2']=$tmp->smallpreviewpic2;
$app['preview3']=$tmp->smallpreviewpic3;
$app['changed']=strtotime($tmp->changed);
$app['description']=$tmp->description;
$app['detailpage']=$tmp->detailpage;
$app['score']=$tmp->score;
2011-06-19 00:02:45 +04:00
return $app;
}
/**
* @brief Get the download url for an application from the OCS server
* @returns array with application data
*
* This function returns an download url for an applications from the OCS server
*/
2012-09-07 17:22:01 +04:00
public static function getApplicationDownload($id,$item) {
if(OC_Config::getValue('appstoreenabled', true)==false) {
return NULL;
}
$url=OC_OCSClient::getAppStoreURL().'/content/download/'.urlencode($id).'/'.urlencode($item);
$xml=OC_OCSClient::getOCSresponse($url);
2012-09-07 17:22:01 +04:00
if($xml==FALSE) {
OC_Log::write('core','Unable to parse OCS content',OC_Log::FATAL);
return NULL;
}
$data=simplexml_load_string($xml);
$tmp=$data->data->content;
$app=array();
2012-08-29 10:38:33 +04:00
if(isset($tmp->downloadlink)) {
$app['downloadlink']=$tmp->downloadlink;
}else{
2012-08-29 22:34:44 +04:00
$app['downloadlink']='';
}
return $app;
}
2011-06-19 00:02:45 +04:00
/**
* @brief Get all the knowledgebase entries from the OCS server
* @returns array with q and a data
*
* This function returns a list of all the knowledgebase entries from the OCS server
*/
2012-09-07 17:22:01 +04:00
public static function getKnownledgebaseEntries($page,$pagesize,$search='') {
if(OC_Config::getValue('knowledgebaseenabled', true)==false) {
$kbe=array();
$kbe['totalitems']=0;
return $kbe;
}
$p= (int) $page;
$s= (int) $pagesize;
2012-04-20 23:49:57 +04:00
if($search<>'') $searchcmd='&search='.urlencode($search); else $searchcmd='';
$url=OC_OCSClient::getKBURL().'/knowledgebase/data?type=150&page='.$p.'&pagesize='.$s.$searchcmd;
2011-06-19 00:02:45 +04:00
$kbe=array();
$xml=OC_OCSClient::getOCSresponse($url);
2012-09-07 17:22:01 +04:00
if($xml==FALSE) {
OC_Log::write('core','Unable to parse knowledgebase content',OC_Log::FATAL);
2011-06-19 00:02:45 +04:00
return NULL;
}
$data=simplexml_load_string($xml);
$tmp=$data->data->content;
for($i = 0; $i < count($tmp); $i++) {
$kb=array();
$kb['id']=$tmp[$i]->id;
$kb['name']=$tmp[$i]->name;
$kb['description']=$tmp[$i]->description;
$kb['answer']=$tmp[$i]->answer;
$kb['preview1']=$tmp[$i]->smallpreviewpic1;
$kb['detailpage']=$tmp[$i]->detailpage;
2011-06-19 00:02:45 +04:00
$kbe[]=$kb;
}
$total=$data->meta->totalitems;
$kbe['totalitems']=$total;
return $kbe;
2011-06-19 00:02:45 +04:00
}
2011-04-17 01:07:18 +04:00
2011-04-16 16:36:32 +04:00
}