summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse.php')
-rw-r--r--www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse.php396
1 files changed, 396 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse.php b/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse.php
new file mode 100644
index 00000000..68d36817
--- /dev/null
+++ b/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/Browse.php
@@ -0,0 +1,396 @@
+<?php
+
+namespace SMW\MediaWiki\Api;
+
+use ApiBase;
+use SMW\ApplicationFactory;
+use SMW\Exception\RedirectTargetUnresolvableException;
+use SMW\Exception\ParameterNotFoundException;
+use SMW\MediaWiki\Api\Browse\ArticleAugmentor;
+use SMW\MediaWiki\Api\Browse\ArticleLookup;
+use SMW\MediaWiki\Api\Browse\SubjectLookup;
+use SMW\MediaWiki\Api\Browse\CachingLookup;
+use SMW\MediaWiki\Api\Browse\ListAugmentor;
+use SMW\MediaWiki\Api\Browse\ListLookup;
+use SMW\MediaWiki\Api\Browse\PValueLookup;
+use SMW\MediaWiki\Api\Browse\PSubjectLookup;
+
+/**
+ * Module to support selected browse activties including:
+ *
+ * @license GNU GPL v2+
+ * @since 3.0
+ *
+ * @author mwjames
+ */
+class Browse extends ApiBase {
+
+ /**
+ * @see ApiBase::execute
+ */
+ public function execute() {
+
+ $params = $this->extractRequestParams();
+
+ $parameters = json_decode( $params['params'], true );
+ $res = [];
+
+ if ( json_last_error() !== JSON_ERROR_NONE || !is_array( $parameters ) ) {
+
+ // 1.29+
+ if ( method_exists($this, 'dieWithError' ) ) {
+ $this->dieWithError( [ 'smw-api-invalid-parameters', 'JSON: '. json_last_error_msg() ] );
+ } else {
+ $this->dieUsage( 'JSON: '. json_last_error_msg(), 'smw-api-invalid-parameters' );
+ }
+ }
+
+ if ( $params['browse'] === 'category' ) {
+ $res = $this->callListLookup( NS_CATEGORY, $parameters );
+ }
+
+ if ( $params['browse'] === 'property' ) {
+ $res = $this->callListLookup( SMW_NS_PROPERTY, $parameters );
+ }
+
+ if ( $params['browse'] === 'concept' ) {
+ $res = $this->callListLookup( SMW_NS_CONCEPT, $parameters );
+ }
+
+ if ( $params['browse'] === 'pvalue' ) {
+ $res = $this->callPValueLookup( $parameters );
+ }
+
+ if ( $params['browse'] === 'psubject' ) {
+ $res = $this->callPSubjectLookup( $parameters );
+ }
+
+ if ( $params['browse'] === 'subject' ) {
+ $res = $this->callSubjectLookup( $parameters );
+ }
+
+ if ( $params['browse'] === 'page' ) {
+ $res = $this->callPageLookup( $parameters );
+ }
+
+ $result = $this->getResult();
+
+ foreach ( $res as $key => $value ) {
+
+ if ( $key === 'query' && is_array( $value ) ) {
+
+ // For those items that start with _xyz as in _MDAT
+ // https://www.mediawiki.org/wiki/API:JSON_version_2
+ // " ... can indicate that a property beginning with an underscore ..."
+ foreach ( $value as $k => $v ) {
+ if ( $k{0} === '_' ) {
+ $result->addPreserveKeysList( 'query', $k );
+ }
+ }
+ }
+
+ $result->addValue( null, $key, $value );
+ }
+ }
+
+ private function callListLookup( $ns, $parameters ) {
+
+ $applicationFactory = ApplicationFactory::getInstance();
+
+ $cacheUsage = $applicationFactory->getSettings()->get(
+ 'smwgCacheUsage'
+ );
+
+ $cacheTTL = CachingLookup::CACHE_TTL;
+
+ if ( isset( $cacheUsage['api.browse'] ) ) {
+ $cacheTTL = $cacheUsage['api.browse'];
+ }
+
+ $store = $applicationFactory->getStore();
+
+ // We explicitly want the SQLStore here to avoid
+ // "Call to undefined method SMW\SPARQLStore\SPARQLStore::getSQLOptions() ..."
+ // since we don't use those methods anywher else other than the SQLStore
+ if ( !is_a( $store, '\SMW\SQLStore\SQLStore') ) {
+ $store = $applicationFactory->getStore( '\SMW\SQLStore\SQLStore' );
+ }
+
+ $listLookup = new ListLookup(
+ $store,
+ new ListAugmentor( $store )
+ );
+
+ $cachingLookup = new CachingLookup(
+ $applicationFactory->getCache(),
+ $listLookup
+ );
+
+ $cachingLookup->setCacheTTL(
+ $cacheTTL
+ );
+
+ $parameters['ns'] = $ns;
+
+ return $cachingLookup->lookup(
+ $parameters
+ );
+ }
+
+ private function callPValueLookup( $parameters ) {
+
+ $applicationFactory = ApplicationFactory::getInstance();
+
+ $cacheUsage = $applicationFactory->getSettings()->get(
+ 'smwgCacheUsage'
+ );
+
+ $cacheTTL = CachingLookup::CACHE_TTL;
+
+ if ( isset( $cacheUsage['api.browse.pvalue'] ) ) {
+ $cacheTTL = $cacheUsage['api.browse.pvalue'];
+ }
+
+ $store = $applicationFactory->getStore();
+
+ // We explicitly want the SQLStore here to avoid
+ // "Call to undefined method SMW\SPARQLStore\SPARQLStore::getSQLOptions() ..."
+ // since we don't use those methods anywher else other than the SQLStore
+ if ( !is_a( $store, '\SMW\SQLStore\SQLStore') ) {
+ $store = $applicationFactory->getStore( '\SMW\SQLStore\SQLStore' );
+ }
+
+ $listLookup = new PValueLookup(
+ $store
+ );
+
+ $cachingLookup = new CachingLookup(
+ $applicationFactory->getCache(),
+ $listLookup
+ );
+
+ $cachingLookup->setCacheTTL(
+ $cacheTTL
+ );
+
+ return $cachingLookup->lookup(
+ $parameters
+ );
+ }
+
+ private function callPSubjectLookup( $parameters ) {
+
+ $applicationFactory = ApplicationFactory::getInstance();
+
+ $cacheUsage = $applicationFactory->getSettings()->get(
+ 'smwgCacheUsage'
+ );
+
+ $cacheTTL = CachingLookup::CACHE_TTL;
+
+ if ( isset( $cacheUsage['api.browse.psubject'] ) ) {
+ $cacheTTL = $cacheUsage['api.browse.psubject'];
+ }
+
+ $store = $applicationFactory->getStore();
+
+ // We explicitly want the SQLStore here to avoid
+ // "Call to undefined method SMW\SPARQLStore\SPARQLStore::getSQLOptions() ..."
+ // since we don't use those methods anywher else other than the SQLStore
+ if ( !is_a( $store, '\SMW\SQLStore\SQLStore') ) {
+ $store = $applicationFactory->getStore( '\SMW\SQLStore\SQLStore' );
+ }
+
+ $listLookup = new PSubjectLookup(
+ $store
+ );
+
+ $cachingLookup = new CachingLookup(
+ $applicationFactory->getCache(),
+ $listLookup
+ );
+
+ $cachingLookup->setCacheTTL(
+ $cacheTTL
+ );
+
+ return $cachingLookup->lookup(
+ $parameters
+ );
+ }
+
+ private function callPageLookup( $parameters ) {
+
+ $applicationFactory = ApplicationFactory::getInstance();
+
+ $cacheUsage = $applicationFactory->getSettings()->get(
+ 'smwgCacheUsage'
+ );
+
+ $cacheTTL = CachingLookup::CACHE_TTL;
+
+ if ( isset( $cacheUsage['api.browse'] ) ) {
+ $cacheTTL = $cacheUsage['api.browse'];
+ }
+
+ $connection = $applicationFactory->getStore()->getConnection( 'mw.db' );
+
+ $articleLookup = new ArticleLookup(
+ $connection,
+ new ArticleAugmentor(
+ $applicationFactory->create( 'TitleFactory' )
+ )
+ );
+
+ $cachingLookup = new CachingLookup(
+ $applicationFactory->getCache(),
+ $articleLookup
+ );
+
+ $cachingLookup->setCacheTTL(
+ $cacheTTL
+ );
+
+ return $cachingLookup->lookup(
+ $parameters
+ );
+ }
+
+ private function callSubjectLookup( $parameters ) {
+
+ $subjectLookup = new SubjectLookup(
+ ApplicationFactory::getInstance()->getStore()
+ );
+
+ try {
+ $res = $subjectLookup->lookup( $parameters );
+ } catch ( RedirectTargetUnresolvableException $e ) {
+ // 1.29+
+ if ( method_exists( $this, 'dieWithError' ) ) {
+ $this->dieWithError( [ 'smw-redirect-target-unresolvable', $e->getMessage() ] );
+ } else {
+ $this->dieUsage( $e->getMessage(), 'redirect-target-unresolvable' );
+ }
+ } catch ( ParameterNotFoundException $e ) {
+ // 1.29+
+ if ( method_exists( $this, 'dieWithError' ) ) {
+ $this->dieWithError( [ 'smw-parameter-missing', $e->getName() ] );
+ } else {
+ $this->dieUsage( $e->getName(), 'smw-parameter-missing' );
+ }
+ }
+
+ return $res;
+ }
+
+ /**
+ * @codeCoverageIgnore
+ * @see ApiBase::getAllowedParams
+ *
+ * @return array
+ */
+ public function getAllowedParams() {
+ return [
+ 'browse' => [
+ ApiBase::PARAM_REQUIRED => true,
+ ApiBase::PARAM_TYPE => [
+
+ // List, browse of properties
+ 'property',
+
+ // List, browse of categories
+ 'category',
+
+ // List, browse of concepts
+ 'concept',
+
+ // List, browse of articles, pages (mediawiki)
+ 'page',
+
+ // Equivalent to Store::getPropertyValues
+ 'pvalue',
+
+ // Equivalent to Store::getPropertySubjects
+ 'psubject',
+
+ // Equivalent to Special:Browse
+ 'subject',
+ ]
+ ],
+ 'params' => [
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true,
+ ],
+ ];
+ }
+
+ /**
+ * @codeCoverageIgnore
+ * @see ApiBase::getParamDescription
+ *
+ * @return array
+ */
+ public function getParamDescription() {
+ return [
+ 'browse' => 'Specifies the type of browse activity',
+ 'params' => 'JSON encoded parameters containing required and optional fields and depend on the selected browse type'
+ ];
+ }
+
+ /**
+ * @codeCoverageIgnore
+ * @see ApiBase::getDescription
+ *
+ * @return array
+ */
+ public function getDescription() {
+ return [
+ 'API module to support browse activties for different entity types in Semantic MediaWiki.'
+ ];
+ }
+
+ /**
+ * @codeCoverageIgnore
+ * @see ApiBase::getExamples
+ *
+ * @return array
+ */
+ protected function getExamples() {
+ return [
+ 'api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date" }',
+ 'api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date", "description": true }',
+ 'api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date", "description": true, "prefLabel": true }',
+ 'api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date", "description": true, "prefLabel": true, "usageCount": true }',
+ 'api.php?action=smwbrowse&browse=pvalue&params={ "limit": 10, "offset": 0, "property" : "Foo", "search": "Bar" }',
+ 'api.php?action=smwbrowse&browse=psubject&params={ "limit": 10, "offset": 0, "property" : "Foo", "value" : "Bar", "search": "foo" }',
+ 'api.php?action=smwbrowse&browse=category&params={ "limit": 10, "offset": 0, "search": "" }',
+ 'api.php?action=smwbrowse&browse=category&params={ "limit": 10, "offset": 0, "search": "Date" }',
+ 'api.php?action=smwbrowse&browse=concept&params={ "limit": 10, "offset": 0, "search": "" }',
+ 'api.php?action=smwbrowse&browse=concept&params={ "limit": 10, "offset": 0, "search": "Date" }',
+ 'api.php?action=smwbrowse&browse=page&params={ "limit": 10, "offset": 0, "search": "Main" }',
+ 'api.php?action=smwbrowse&browse=page&params={ "limit": 10, "offset": 0, "search": "Main", "fullText": true, "fullURL": true }',
+ 'api.php?action=smwbrowse&browse=subject&params={ "subject": "Main page", "ns" :0, "iw": "", "subobject": "" }',
+ ];
+ }
+
+ /**
+ * @codeCoverageIgnore
+ * @see ApiBase::getVersion
+ *
+ * @return string
+ */
+ public function getVersion() {
+ return __CLASS__ . ':' . SMW_VERSION;
+ }
+
+ /**
+ * @codeCoverageIgnore
+ * @see ApiBase::getVersion
+ *
+ * @return string
+ */
+ public function getHelpUrls() {
+ return 'https://www.semantic-mediawiki.org/wiki/Help:API';
+ }
+
+}
generated by cgit v1.2.1 (git 2.18.0) at 2024-05-04 19:44:44 +0000