SemanticMediaWiki/includes/SMW_Infolink.php

Go to the documentation of this file.

<?php
class SMWInfolink {

        protected $mTarget;

        protected $mCaption;

        protected $mStyle;

        protected $mInternal;

        protected $mParams;

        public function __construct( $internal, $caption, $target, $style = false, array $params = array() ) {
                $this->mInternal = $internal;
                $this->mCaption = $caption;
                $this->mTarget = $target;
                $this->mStyle = $style;
                $this->mParams = $params;
        }

        public static function newInternalLink( $caption, $target, $style = false, array $params = array() ) {
                return new SMWInfolink( true, $caption, $target, $style, $params );
        }

        public static function newExternalLink( $caption, $url, $style = false, array $params = array() ) {
                return new SMWInfolink( false, $caption, $url, $style, $params );
        }

        public static function newPropertySearchLink( $caption, $propertyName, $propertyValue, $style = 'smwsearch' ) {
                global $wgContLang;
                return new SMWInfolink(
                        true,
                        $caption,
                        $wgContLang->getNsText( NS_SPECIAL ) . ':SearchByProperty',
                        $style,
                        array( $propertyName, $propertyValue )
                );
        }

        public static function newInversePropertySearchLink( $caption, $subject, $propertyname, $style = false ) {
                global $wgContLang;
                return new SMWInfolink(
                        true,
                        $caption,
                        $wgContLang->getNsText( NS_SPECIAL ) . ':PageProperty/' .  $subject . '::' . $propertyname,
                        $style
                );
        }

        public static function newBrowsingLink( $caption, $titleText, $style = 'smwbrowse' ) {
                global $wgContLang;
                return new SMWInfolink(
                        true,
                        $caption,
                        $wgContLang->getNsText( NS_SPECIAL ) . ':Browse',
                        $style,
                        array( $titleText )
                );
        }

        public function setParameter( $value, $key = false ) {
                if ( $key === false ) {
                        $this->mParams[] = $value;
                } else {
                        $this->mParams[$key] = $value;
                }
        }

        public function getParameter( $key ) {
                if ( array_key_exists( $key, $this->mParams ) ) {
                        return $this->mParams[$key];
                } else {
                        return null;
                }
        }

        public function setCaption( $caption ) {
                $this->mCaption = $caption;
        }

        public function setStyle( $style ) {
                $this->mStyle = $style;
        }

        public function getText( $outputformat, $linker = null ) {
                if ( $this->mStyle !== false ) {
                        SMWOutputs::requireResource( 'ext.smw.style' );
                        $start = "<span class=\"$this->mStyle\">";
                        $end = '</span>';
                } else {
                        $start = '';
                        $end = '';
                }

                if ( $this->mInternal ) {
                        if ( count( $this->mParams ) > 0 ) {
                                $titletext = $this->mTarget . '/' . SMWInfolink::encodeParameters( $this->mParams );
                        } else {
                                $titletext = $this->mTarget;
                        }

                        $title = Title::newFromText( $titletext );

                        if ( !is_null( $title ) ) {
                                if ( $outputformat == SMW_OUTPUT_WIKI ) {
                                        $link = "[[$titletext|$this->mCaption]]";
                                } else { // SMW_OUTPUT_HTML, SMW_OUTPUT_FILE
                                        $link = $this->getLinker( $linker )->link( $title, $this->mCaption );
                                }
                        } else { // Title creation failed, maybe illegal symbols or too long; make a direct URL link
                                 // (only possible if offending target parts belong to some parameter
                                 //  that can be separated from title text,
                                 //  e.g. as in Special:Bla/il<leg>al -> Special:Bla&p=il&lt;leg&gt;al)
                                $title = Title::newFromText( $this->mTarget );

                                if ( !is_null( $title ) ) {
                                        if ( $outputformat == SMW_OUTPUT_WIKI ) {
                                                $link = '[' . $title->getFullURL( SMWInfolink::encodeParameters( $this->mParams, false ) ) . " $this->mCaption]";
                                        } else { // SMW_OUTPUT_HTML, SMW_OUTPUT_FILE
                                                $link = $this->getLinker( $linker )->link(
                                                        $title,
                                                        $this->mCaption,
                                                        array(),
                                                        SMWInfolink::encodeParameters( $this->mParams, false )
                                                );
                                        }
                                } else {
                                        return ''; // the title was bad, normally this would indicate a software bug
                                }
                        }
                } else {
                        $target = $this->getURL();

                        if ( $outputformat == SMW_OUTPUT_WIKI ) {
                                $link = "[$target $this->mCaption]";
                        } else { // SMW_OUTPUT_HTML, SMW_OUTPUT_FILE
                                $link = '<a href="' . htmlspecialchars( $target ) . "\">$this->mCaption</a>";
                        }
                }

                return $start . $link . $end;
        }

        public function getHTML( $linker = null ) {
                return $this->getText( SMW_OUTPUT_HTML, $linker );
        }

        public function getWikiText( $linker = null ) {
                return $this->getText( SMW_OUTPUT_WIKI, $linker );
        }

        public function getURL() {
                if ( $this->mInternal ) {
                        $title = Title::newFromText( $this->mTarget );

                        if ( !is_null( $title ) ) {
                                return $title->getFullURL( SMWInfolink::encodeParameters( $this->mParams, false ) );
                        } else {
                                return ''; // the title was bad, normally this would indicate a software bug
                        }
                } else {
                        if ( count( $this->mParams ) > 0 ) {
                                if ( strpos( SMWExporter::expandURI( '&wikiurl;' ), '?' ) === false ) {
                                        $target = $this->mTarget . '?' . SMWInfolink::encodeParameters( $this->mParams, false );
                                } else {
                                        $target = $this->mTarget . '&' . SMWInfolink::encodeParameters( $this->mParams, false );
                                }
                        } else {
                                $target = $this->mTarget;
                        }

                        return $target;
                }
        }


        protected function getLinker( &$linker = null ) {
                if ( is_null( $linker ) ) {
                        $linker = class_exists('DummyLinker') ? new DummyLinker : new Linker;
                }
                return $linker;
        }

        static public function encodeParameters( array $params, $forTitle = true ) {
                $result = '';

                if ( $forTitle ) {
                        foreach ( $params as $name => $value ) {
                                if ( is_string( $name ) && ( $name !== '' ) ) {
                                        $value = $name . '=' . $value;
                                }
                                // Escape certain problematic values. Use SMW-escape
                                // (like URLencode but - instead of % to prevent double encoding by later MW actions)
                                //
                                // - : used in SMW-encoding strings, needs escaping too
                                // [ ] < > &lt; &gt; '' |: problematic in MW titles
                                // & : sometimes problematic in MW titles ([[&amp;]] is OK, [[&test]] is OK, [[&test;]] is not OK)
                                //     (Note: '&' in strings obtained during parsing already has &entities; replaced by
                                //      UTF8 anyway)
                                // ' ': are equivalent with '_' in MW titles, but are not equivalent in certain parameter values
                                // "\n": real breaks not possible in [[...]]
                                // "#": has special meaning in URLs, triggers additional MW escapes (using . for %)
                                // '%': must be escaped to prevent any impact of double decoding when replacing -
                                //      by % before urldecode
                                // '?': if not escaped, strange effects were observed on some sites (printout and other
                                //      parameters ignored without obvious cause); SMW-escaping is always save to do -- it just
                                //      make URLs less readable
                                //
                                $value = str_replace(
                                        array( '-', '#', "\n", ' ', '/', '[', ']', '<', '>', '&lt;', '&gt;', '&amp;', '\'\'', '|', '&', '%', '?', '$' ),
                                        array( '-2D', '-23', '-0A', '-20', '-2F', '-5B', '-5D', '-3C', '-3E', '-3C', '-3E', '-26', '-27-27', '-7C', '-26', '-25', '-3F', '-24' ),
                                        $value
                                );

                                if ( $result !== '' ) {
                                        $result .= '/';
                                }

                                $result .= $value;
                        }
                } else { // Note: this requires to have HTTP compatible parameter names (ASCII)
                        $q = array(); // collect unlabelled query parameters here

                        foreach ( $params as $name => $value ) {
                                if ( is_string( $name ) && ( $name !== '' ) ) {
                                        $value = $name . '=' . rawurlencode( $value );

                                        if ( $result !== '' ) {
                                                $result .= '&';
                                        }

                                        $result .= $value;
                                } else {
                                        $q[] = $value;
                                }
                        }
                        if ( count( $q ) > 0 ) { // prepend encoding for unlabelled parameters
                                if ( $result !== '' ) {
                                        $result = '&' . $result;
                                }
                                $result = 'x=' . rawurlencode( SMWInfolink::encodeParameters( $q, true ) ) . $result;
                        }
                }

                return $result;
        }

        static public function decodeParameters( $titleParam = '', $allParams = false ) {
                global $wgRequest;

                $result = array();

                if ( $allParams ) {
                        $result = $wgRequest->getValues();

                        if ( array_key_exists( 'x', $result ) ) { // Considered to be part of the title param.
                                if ( $titleParam !== '' ) {
                                        $titleParam .= '/';
                                }
                                $titleParam .= $result['x'];
                                unset( $result['x'] );
                        }
                }

                if ( is_array( $titleParam ) ) {
                        return $titleParam;
                } elseif ( $titleParam !== '' ) {
                        // unescape $p; escaping scheme: all parameters rawurlencoded, "-" and "/" urlencoded, all "%" replaced by "-", parameters then joined with /
                        $ps = explode( '/', $titleParam ); // params separated by / here (compatible with wiki link syntax)

                        foreach ( $ps as $p ) {
                                if ( $p !== '' ) {
                                        $p = rawurldecode( str_replace( '-', '%', $p ) );
                                        $parts = explode( '=', $p, 2 );

                                        if ( count( $parts ) > 1 ) {
                                                $result[$parts[0]] = $parts[1];
                                        } else {
                                                $result[] = $p;
                                        }
                                }
                        }
                }

                return $result;
        }

}

---