SemanticMediaWiki/includes/queryprinters/SMW_QueryPrinter.php

Go to the documentation of this file.

<?php
// Constants that define how/if headers should be displayed.
define( 'SMW_HEADERS_SHOW', 2 );
define( 'SMW_HEADERS_PLAIN', 1 );
define( 'SMW_HEADERS_HIDE', 0 ); // Used to be "false" hence use "0" to support extensions that still assume this.

abstract class SMWResultPrinter {

        protected $m_params;
        
        protected $params;

        protected $mIntro = '';

        protected $mOutro = '';

        protected $mSearchlabel = null;

        protected $mDefault = '';

        // parameters relevant for printers in general:
        protected $mFormat; // a string identifier describing a valid format
        protected $mLinkFirst; // should article names of the first column be linked?
        protected $mLinkOthers; // should article names of other columns (besides the first) be linked?
        protected $mShowHeaders = SMW_HEADERS_SHOW; // should the headers (property names) be printed?
        protected $mShowErrors = true; // should errors possibly be printed?
        protected $mInline; // is this query result "inline" in some page (only then a link to unshown results is created, error handling may also be affected)
        protected $mLinker; // Linker object as needed for making result links. Might come from some skin at some time.

        protected $mErrors = array();
        
        protected $isHTML = false;

        protected $hasTemplates = false;
        private static $mRecursionDepth = 0;
        public static $maxRecursionDepth = 2;

        abstract protected function getResultText( SMWQueryResult $res, $outputmode );

        public function __construct( $format, $inline, $useValidator = false ) {
                global $smwgQDefaultLinking;

                $this->mFormat = $format;
                $this->mInline = $inline;
                $this->mLinkFirst = ( $smwgQDefaultLinking != 'none' );
                $this->mLinkOthers = ( $smwgQDefaultLinking == 'all' );
                $this->mLinker = class_exists( 'DummyLinker' ) ? new DummyLinker : new Linker; 
        }

        public function getResult( SMWQueryResult $results, array $params, $outputmode ) {
                $this->isHTML = false;
                $this->hasTemplates = false;
                
                $this->handleParameters( $params, $outputmode );
                
                // Default output for normal printers:
                if ( ( $outputmode != SMW_OUTPUT_FILE ) && // not in FILE context,
                                ( $results->getCount() == 0 ) && // no results,
                                ( $this->getMimeType( $results ) === false ) ) { // normal printer -> take over processing
                        if ( !$results->hasFurtherResults() ) {
                                return $this->escapeText( $this->mDefault, $outputmode ) . $this->getErrorString( $results );
                        } elseif ( $this->mInline ) {
                                $label = $this->mSearchlabel;

                                if ( $label === null ) { // apply defaults
                                        $label = wfMsgForContent( 'smw_iq_moreresults' );
                                }

                                if ( $label !== '' ) {
                                        $link = $results->getQueryLink( $this->escapeText( $label, $outputmode ) );
                                        $result = $link->getText( $outputmode, $this->mLinker );
                                } else {
                                        $result = '';
                                }

                                $result .= $this->getErrorString( $results );

                                return $result;
                        }
                }
                
                // Get output from printer:
                $result = $this->getResultText( $results, $outputmode );

                if ( $outputmode != SMW_OUTPUT_FILE ) {
                        $result = $this->handleNonFileResult( $result, $results, $outputmode );
                }
                
                if ( $GLOBALS['wgDBtype'] == 'postgres' ) {
                        $result = pg_unescape_bytea( $result );
                }
                
                return $result;
        }
        
        protected function handleNonFileResult( $result, SMWQueryResult $results, $outputmode ) {
                global $wgParser;
                $result .= $this->getErrorString( $results ); // append errors

                if ( ( !$this->isHTML ) && ( $this->hasTemplates ) ) { // preprocess embedded templates if needed
                        if ( ( $wgParser->getTitle() instanceof Title ) && ( $wgParser->getOptions() instanceof ParserOptions ) ) {
                                SMWResultPrinter::$mRecursionDepth++;

                                if ( SMWResultPrinter::$mRecursionDepth <= SMWResultPrinter::$maxRecursionDepth ) { // restrict recursion
                                        $result = '[[SMW::off]]' . $wgParser->replaceVariables( $result ) . '[[SMW::on]]';
                                } else {
                                        $result = ''; 
                                }

                                SMWResultPrinter::$mRecursionDepth--;
                        } else { // not during parsing, no preprocessing needed, still protect the result
                                $result = '[[SMW::off]]' . $result . '[[SMW::on]]';
                        }
                }

                if ( ( $this->isHTML ) && ( $outputmode == SMW_OUTPUT_WIKI ) ) {
                        $result = array( $result, 'isHTML' => true );
                } elseif ( ( !$this->isHTML ) && ( $outputmode == SMW_OUTPUT_HTML ) ) {
                        SMWResultPrinter::$mRecursionDepth++;

                        // check whether we are in an existing parse, or if we should start a new parse for $wgTitle
                        if ( SMWResultPrinter::$mRecursionDepth <= SMWResultPrinter::$maxRecursionDepth ) { // retrict recursion
                                if ( ( $wgParser->getTitle() instanceof Title ) && ( $wgParser->getOptions() instanceof ParserOptions ) ) {
                                        $result = $wgParser->recursiveTagParse( $result );
                                } else {
                                        global $wgTitle;

                                        $popt = new ParserOptions();
                                        $popt->setEditSection( false );
                                        $pout = $wgParser->parse( $result . '__NOTOC__', $wgTitle, $popt );

                                        SMWOutputs::requireFromParserOutput( $pout );
                                        $result = $pout->getText();
                                }
                        } else {
                                $result = ''; 
                        }

                        SMWResultPrinter::$mRecursionDepth--;
                }

                if ( ( $this->mIntro ) && ( $results->getCount() > 0 ) ) {
                        if ( $outputmode == SMW_OUTPUT_HTML ) {
                                global $wgParser;
                                $result = $wgParser->recursiveTagParse( $this->mIntro ) . $result;
                        } else {
                                $result = $this->mIntro . $result;
                        }
                }

                if ( ( $this->mOutro ) && ( $results->getCount() > 0 ) ) {
                        if ( $outputmode == SMW_OUTPUT_HTML ) {
                                global $wgParser;
                                $result = $result . $wgParser->recursiveTagParse( $this->mOutro );
                        } else {
                                $result = $result . $this->mOutro;
                        }
                }

                return $result;         
        }
        
        protected function handleParameters( array $params, $outputmode ) {
                $this->params = $params;
                $this->m_params = $params; // Compat, change made in 1.6.3/1.7
                
                if ( array_key_exists( 'intro', $params ) ) { $this->mIntro = $params['intro']; }
                if ( array_key_exists( 'outro', $params ) ) { $this->mOutro = $params['outro']; }
                
                if ( array_key_exists( 'searchlabel', $params ) ) {
                        $this->mSearchlabel = $params['searchlabel'] === false ? null : $params['searchlabel'];
                }

                switch ( $params['link'] ) {
                        case 'head': case 'subject':
                                $this->mLinkFirst = true;
                                $this->mLinkOthers = false;
                                break;
                        case 'all':
                                $this->mLinkFirst = true;
                                $this->mLinkOthers = true;
                                break;
                        case 'none':
                                $this->mLinkFirst = false;
                                $this->mLinkOthers = false;
                                break;                  
                }
                
                if ( array_key_exists( 'default', $params ) ) { $this->mDefault = str_replace( '_', ' ', $params['default'] ); }
                
                if ( $params['headers'] == 'hide' ) {
                        $this->mShowHeaders = SMW_HEADERS_HIDE;
                } elseif ( $params['headers'] == 'plain' ) {
                        $this->mShowHeaders = SMW_HEADERS_PLAIN;
                } else {
                        $this->mShowHeaders = SMW_HEADERS_SHOW;
                }               
        }

        protected function getLinker( $firstcol = false ) {
                if ( ( $firstcol && $this->mLinkFirst ) || ( !$firstcol && $this->mLinkOthers ) ) {
                        return $this->mLinker;
                } else {
                        return null;
                }
        }

        public function getMimeType( $res ) {
                return false;
        }

        public function getQueryMode( $context ) {
                return SMWQuery::MODE_INSTANCES;
        }

        public function getFileName( $res ) {
                return false;
        }

        public function getName() {
                return $this->mFormat;
        }

        public function getErrorString( SMWQueryResult $res ) {
                return $this->mShowErrors ? smwfEncodeMessages( array_merge( $this->mErrors, $res->getErrors() ) ) : '';
        }

        public function setShowErrors( $show ) {
                $this->mShowErrors = $show;
        }

        protected function escapeText( $text, $outputmode ) {
                return ( $outputmode == SMW_OUTPUT_HTML ) ? htmlspecialchars( $text ) : $text;
        }

        protected function getSearchLabel( $outputmode ) {
                return $this->escapeText( $this->mSearchlabel, $outputmode );
        }

        protected function linkFurtherResults( $results ) {
                return $this->mInline && $results->hasFurtherResults() && $this->mSearchlabel !== '';
        }
        
        protected function addError( $errorMessage ) {
                $this->mErrors[] = $errorMessage;
        }

        protected function textDisplayParameters() {
                $params = array();
                
                $params['intro'] = new Parameter( 'intro' );
                $params['intro']->setMessage( 'smw_paramdesc_intro' );
                $params['intro']->setDefault( '' );
                
                $params['outro'] = new Parameter( 'outro' );
                $params['outro']->setMessage( 'smw_paramdesc_outro' );
                $params['outro']->setDefault( '' );
                
                $params['default'] = new Parameter( 'default' );
                $params['default']->setMessage( 'smw_paramdesc_default' );
                $params['default']->setDefault( '' );
                
                return $params;
        }

        protected function exportFormatParameters() {
                $params = array();
                
                $params['searchlabel'] = new Parameter( 'searchlabel' );
                $params['searchlabel']->setMessage( 'smw_paramdesc_searchlabel' );
                $params['searchlabel']->setDefault( false, false );
                
                return $params;
        }

        public function getValidatorParameters() {
                $params = array();
                
                foreach ( $this->getParameters() as $param ) {
                        $param = $this->toValidatorParam( $param );
                        $params[$param->getName()] = $param;
                }
                
                return $params;
        }
        
        protected function toValidatorParam( $param ) {
                static $typeMap = array(
                        'int' => Parameter::TYPE_INTEGER
                );

                if ( !( $param instanceof Parameter ) ) {
                        if ( !array_key_exists( 'type', $param ) ) {
                                $param['type'] = 'string';
                        }

                        $paramClass = $param['type'] == 'enum-list' ? 'ListParameter' : 'Parameter';
                        $paramType = array_key_exists( $param['type'], $typeMap ) ? $typeMap[$param['type']] : Parameter::TYPE_STRING;

                        $parameter = new $paramClass( $param['name'], $paramType );

                        if ( array_key_exists( 'description', $param ) ) {
                                $parameter->setDescription( $param['description'] );
                        }

                        if ( array_key_exists( 'values', $param ) && is_array( $param['values'] ) ) {
                                $parameter->addCriteria( new CriterionInArray( $param['values'] ) );
                        }

                        return $parameter;
                }
                else {
                        return $param;
                }
        }
        
        public function getParameters() {
                return array();
        }

}

---