SemanticMediaWiki/includes/datavalues/SMW_DV_URI.php

Go to the documentation of this file.

<?php
define( 'SMW_URI_MODE_EMAIL', 1 );
define( 'SMW_URI_MODE_URI', 3 );
define( 'SMW_URI_MODE_ANNOURI', 4 );
define( 'SMW_URI_MODE_TEL', 5 );

class SMWURIValue extends SMWDataValue {

        protected $m_wikitext;
        private $m_mode;

        public function __construct( $typeid ) {
                parent::__construct( $typeid );
                switch ( $typeid ) {
                        case '_ema':
                                $this->m_mode = SMW_URI_MODE_EMAIL;
                        break;
                        case '_anu':
                                $this->m_mode = SMW_URI_MODE_ANNOURI;
                        break;
                        case '_tel':
                                $this->m_mode = SMW_URI_MODE_TEL;
                        break;
                        case '_uri': case '_url': case '__spu': default:
                                $this->m_mode = SMW_URI_MODE_URI;
                        break;
                }
        }

        protected function parseUserValue( $value ) {
                $value = trim( $value );
                $this->m_wikitext = $value;
                if ( $this->m_caption === false ) {
                        $this->m_caption = $this->m_wikitext;
                }

                $scheme = $hierpart = $query = $fragment = '';
                if ( $value === '' ) { // do not accept empty strings
                        $this->addError( wfMsgForContent( 'smw_emptystring' ) );
                        $this->m_dataitem = new SMWDIUri( 'http', '//example.com', '', '', $this->m_typeid ); // define data item to have some value
                        return;
                }

                switch ( $this->m_mode ) {
                        case SMW_URI_MODE_URI: case SMW_URI_MODE_ANNOURI:
                                $parts = explode( ':', $value, 2 ); // try to split "schema:rest"
                                if ( count( $parts ) == 1 ) { // possibly add "http" as default
                                        $value = 'http://' . $value;
                                        $parts[1] = $parts[0];
                                        $parts[0] = 'http';
                                }
                                // check against blacklist
                                $uri_blacklist = explode( "\n", wfMsgForContent( 'smw_uri_blacklist' ) );
                                foreach ( $uri_blacklist as $uri ) {
                                        $uri = trim( $uri );
                                        if ( $uri == mb_substr( $value, 0, mb_strlen( $uri ) ) ) { // disallowed URI!
                                                $this->addError( wfMsgForContent( 'smw_baduri', $value ) );
                                                $this->m_dataitem = new SMWDIUri( 'http', '//example.com', '', '', $this->m_typeid ); // define data item to have some value
                                                return;
                                        }
                                }
                                // decompose general URI components
                                $scheme = $parts[0];
                                $parts = explode( '?', $parts[1], 2 ); // try to split "hier-part?queryfrag"
                                if ( count( $parts ) == 2 ) {
                                        $hierpart = $parts[0];
                                        $parts = explode( '#', $parts[1], 2 ); // try to split "query#frag"
                                        $query = $parts[0];
                                        $fragment = ( count( $parts ) == 2 ) ? $parts[1] : '';
                                } else {
                                        $query = '';
                                        $parts = explode( '#', $parts[0], 2 ); // try to split "hier-part#frag"
                                        $hierpart = $parts[0];
                                        $fragment = ( count( $parts ) == 2 ) ? $parts[1] : '';
                                }
                                // We do not validate the URI characters (the data item will do this) but we do some escaping:
                                // encode most characters, but leave special symbols as given by user:
                                $hierpart = str_replace( array( '%3A', '%2F', '%23', '%40', '%3F', '%3D', '%26', '%25' ), array( ':', '/', '#', '@', '?', '=', '&', '%' ), rawurlencode( $hierpart ) );
                                $query = str_replace( array( '%3A', '%2F', '%23', '%40', '%3F', '%3D', '%26', '%25' ), array( ':', '/', '#', '@', '?', '=', '&', '%' ), rawurlencode( $query ) );
                                $fragment = str_replace( array( '%3A', '%2F', '%23', '%40', '%3F', '%3D', '%26', '%25' ), array( ':', '/', '#', '@', '?', '=', '&', '%' ), rawurlencode( $fragment ) );

                                if ( substr( $hierpart, 0, 2 ) === '//' ) {
                                        $hierpart = substr( $hierpart, 2 );
                                }
                                break;
                        case SMW_URI_MODE_TEL:
                                $scheme = 'tel';
                                if ( substr( $value, 0, 4 ) === 'tel:' ) { // accept optional "tel"
                                        $value = substr( $value, 4 );
                                        $this->m_wikitext = $value;
                                }
                                $hierpart = preg_replace( '/(?<=[0-9]) (?=[0-9])/', '\1-\2', $value );
                                $hierpart = str_replace( ' ', '', $hierpart );
                                if ( substr( $hierpart, 0, 2 ) == '00' ) {
                                        $hierpart = '+' . substr( $hierpart, 2 );
                                }
                                if ( ( strlen( preg_replace( '/[^0-9]/', '', $hierpart ) ) < 6 ) ||
                                        ( preg_match( '<[-+./][-./]>', $hierpart ) ) ||
                                        ( !SMWURIValue::isValidTelURI( 'tel:' . $hierpart ) ) ) { 
                                        $this->addError( wfMsgForContent( 'smw_baduri', $this->m_wikitext ) );
                                }
                                break;
                        case SMW_URI_MODE_EMAIL:
                                $scheme = 'mailto';
                                if ( strpos( $value, 'mailto:' ) === 0 ) { // accept optional "mailto"
                                        $value = substr( $value, 7 );
                                        $this->m_wikitext = $value;
                                }

                                $check = method_exists( 'Sanitizer', 'validateEmail' ) ? Sanitizer::validateEmail( $value ) : self::validateEmail( $value );
                                if ( !$check ) {
                                        $this->addError( wfMsgForContent( 'smw_baduri', $value ) );
                                        break;
                                }
                                $hierpart = str_replace( array( '%3A', '%2F', '%23', '%40', '%3F', '%3D', '%26', '%25' ), array( ':', '/', '#', '@', '?', '=', '&', '%' ), rawurlencode( $value ) );
                }

                // Now create the URI data item:
                try {
                        $this->m_dataitem = new SMWDIUri( $scheme, $hierpart, $query, $fragment, $this->m_typeid );
                } catch ( SMWDataItemException $e ) {
                        $this->addError( wfMsgForContent( 'smw_baduri', $this->m_wikitext ) );
                        $this->m_dataitem = new SMWDIUri( 'http', '//example.com', '', '', $this->m_typeid ); // define data item to have some value
                }
        }

        protected static function isValidTelURI( $s ) {
                $tel_uri_regex = '<^tel:\+[0-9./-]*[0-9][0-9./-]*(;[0-9a-zA-Z-]+=(%[0-9a-zA-Z][0-9a-zA-Z]|[0-9a-zA-Z._~:/?#[\]@!$&\'()*+,;=-])*)*$>';
                return (bool) preg_match( $tel_uri_regex, $s );
        }

        protected function loadDataItem( SMWDataItem $dataItem ) {
                if ( $dataItem->getDIType() == SMWDataItem::TYPE_URI ) {
                        $this->m_dataitem = $dataItem;
                        if ( $this->m_mode == SMW_URI_MODE_EMAIL ) {
                                $this->m_wikitext = substr( $dataItem->getURI(), 7 );
                        } elseif ( $this->m_mode == SMW_URI_MODE_TEL ) {
                                $this->m_wikitext = substr( $dataItem->getURI(), 4 );
                        } else {
                                $this->m_wikitext = $dataItem->getURI();
                        }
                        $this->m_caption = $this->m_wikitext;
                        return true;
                } else {
                        return false;
                }
        }

        public function getShortWikiText( $linked = null ) {
                $url = $this->getURL();
                if ( is_null( $linked ) || ( $linked === false ) || ( $this->m_outformat == '-' ) || ( $url === '' ) || ( $this->m_caption === '' ) ) {
                        return $this->m_caption;
                } else {
                        return '[' . $url . ' ' . $this->m_caption . ']';
                }
        }

        public function getShortHTMLText( $linker = null ) {
                $url = $this->getURL();
                if ( is_null( $linker ) || ( !$this->isValid() ) || ( $this->m_outformat == '-' ) || ( $url === '' ) || ( $this->m_caption === '' ) ) {
                        return $this->m_caption;
                } else {
                        return $linker->makeExternalLink( $url, $this->m_caption );
                }
        }

        public function getLongWikiText( $linked = null ) {
                if ( !$this->isValid() ) {
                        return $this->getErrorText();
                }
                $url = $this->getURL();

                if ( is_null( $linked ) || ( $linked === false ) || ( $this->m_outformat == '-' ) || ( $url === '' ) ) {
                        return $this->m_wikitext;
                } else {
                        return '[' . $url . ' ' . $this->m_wikitext . ']';
                }
        }

        public function getLongHTMLText( $linker = null ) {
                if ( !$this->isValid() ) {
                        return $this->getErrorText();
                }

                $url = $this->getURL();

                if ( is_null( $linker ) || ( $this->m_outformat == '-' ) || ( $url === '' ) ) {
                        return htmlspecialchars( $this->m_wikitext );
                } else {
                        return $linker->makeExternalLink( $url, $this->m_wikitext );
                }
        }

        public function getWikiValue() {
                return $this->m_wikitext;
        }

        public function getURI() {
                return $this->m_dataitem->getURI();
        }

        protected function getServiceLinkParams() {
                // Create links to mapping services based on a wiki-editable message. The parameters
                // available to the message are:
                // $1: urlencoded version of URI/URL value (includes mailto: for emails)
                return array( rawurlencode( $this->m_dataitem->getURI() ) );
        }

        public function getURL() {
                global $wgUrlProtocols;

                foreach ( $wgUrlProtocols as $prot ) {
                        if ( ( $prot == $this->m_dataitem->getScheme() . ':' ) || ( $prot == $this->m_dataitem->getScheme() . '://' ) ) {
                                return $this->m_dataitem->getURI();
                        }
                }

                return '';
        }

        public static function validateEmail( $addr ) {
                $result = null;
                if ( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
                        return $result;
                }

                // Please note strings below are enclosed in brackets [], this make the
                // hyphen "-" a range indicator. Hence it is double backslashed below.
                // See bug 26948
                $rfc5322_atext   = "a-z0-9!#$%&'*+\\-\/=?^_`{|}~" ;
                $rfc1034_ldh_str = "a-z0-9\\-" ;

                $HTML5_email_regexp = "/
                ^                      # start of string
                [$rfc5322_atext\\.]+    # user part which is liberal :p
                @                      # 'apostrophe'
                [$rfc1034_ldh_str]+       # First domain part
                (\\.[$rfc1034_ldh_str]+)*  # Following part prefixed with a dot
                $                      # End of string
                /ix" ; // case Insensitive, eXtended

                return (bool) preg_match( $HTML5_email_regexp, $addr );
        }

}

---