SemanticMediaWiki/specials/SearchTriple/SMW_SpecialBrowse.php

Go to the documentation of this file.

<?php
class SMWSpecialBrowse extends SpecialPage {
        static public $incomingvaluescount = 8;
        static public $incomingpropertiescount = 21;
        private $subject = null;
        private $articletext = "";
        private $showoutgoing = true;
        private $showincoming = false;
        private $offset = 0;

        public function __construct() {
                global $smwgBrowseShowAll;
                parent::__construct( 'Browse', '', true, false, 'default', true );
                if ( $smwgBrowseShowAll ) {
                        SMWSpecialBrowse::$incomingvaluescount = 21;
                        SMWSpecialBrowse::$incomingpropertiescount = - 1;
                }
        }

        public function execute( $query ) {
                global $wgRequest, $wgOut, $smwgBrowseShowAll;
                $this->setHeaders();
                // get the GET parameters
                $this->articletext = $wgRequest->getVal( 'article' );
                // no GET parameters? Then try the URL
                if ( is_null( $this->articletext ) ) {
                        $params = SMWInfolink::decodeParameters( $query, false );
                        reset( $params );
                        $this->articletext = current( $params );
                }
                
                $this->subject = SMWDataValueFactory::newTypeIDValue( '_wpg', $this->articletext );
                $offsettext = $wgRequest->getVal( 'offset' );
                $this->offset = ( is_null( $offsettext ) ) ? 0 : intval( $offsettext );
                
                $dir = $wgRequest->getVal( 'dir' );
                
                if ( $smwgBrowseShowAll ) {
                        $this->showoutgoing = true;
                        $this->showincoming = true;
                }
                
                if ( $dir === 'both' || $dir === 'in' ) {
                        $this->showincoming = true;
                }
                
                if ( $dir === 'in' ) {
                        $this->showoutgoing = false;
                }
                
                if ( $dir === 'out' ) {
                        $this->showincoming = false;
                }

                $wgOut->addHTML( $this->displayBrowse() );
                SMWOutputs::commitToOutputPage( $wgOut ); // make sure locally collected output data is pushed to the output!
        }

        private function displayBrowse() {
                global $wgContLang, $wgOut;
                $html = "\n";
                $leftside = !( $wgContLang->isRTL() ); // For right to left languages, all is mirrored
                
                if ( $this->subject->isValid() ) {
                        $wgOut->addStyle( '../extensions/SemanticMediaWiki/skins/SMW_custom.css' );

                        $html .= $this->displayHead();
                        
                        if ( $this->showoutgoing ) {
                                $data = smwfGetStore()->getSemanticData( $this->subject->getDataItem() );
                                $html .= $this->displayData( $data, $leftside );
                                $html .= $this->displayCenter();
                        }
                        
                        if ( $this->showincoming ) {
                                list( $indata, $more ) = $this->getInData();
                                global $smwgBrowseShowInverse;
                                
                                if ( !$smwgBrowseShowInverse ) {
                                        $leftside = !$leftside;
                                }
                                
                                $html .= $this->displayData( $indata, $leftside, true );
                                $html .= $this->displayBottom( $more );
                        }

                        $this->articletext = $this->subject->getWikiValue();
                        
                        // Add a bit space between the factbox and the query form
                        if ( !$this->including() ) {
                                $html .= "<p> &#160; </p>\n";
                        }
                }
                
                if ( !$this->including() ) {
                        $html .= $this->queryForm();
                }
                
                $wgOut->addHTML( $html );
        }

        private function displayData( SMWSemanticData $data, $left = true, $incoming = false ) {
                // Some of the CSS classes are different for the left or the right side.
                // In this case, there is an "i" after the "smwb-". This is set here.
                $ccsPrefix = $left ? 'smwb-' : 'smwb-i';

                $html = "<table class=\"{$ccsPrefix}factbox\" cellpadding=\"0\" cellspacing=\"0\">\n";

                $diProperties = $data->getProperties();
                $noresult = true;
                foreach ( $diProperties as $key => $diProperty ) {
                        $dvProperty = SMWDataValueFactory::newDataItemValue( $diProperty, null );

                        if ( $dvProperty->isVisible() ) {
                                $dvProperty->setCaption( $this->getPropertyLabel( $dvProperty, $incoming ) );
                                $proptext = $dvProperty->getShortHTMLText( smwfGetLinker() ) . "\n";
                        } elseif ( $diProperty->getKey() == '_INST' ) {
                                $proptext = smwfGetLinker()->specialLink( 'Categories' );
                        } elseif ( $diProperty->getKey() == '_REDI' ) {
                                $proptext = smwfGetLinker()->specialLink( 'Listredirects', 'isredirect' );
                        } else {
                                continue; // skip this line
                        }

                        $head  = '<th>' . $proptext . "</th>\n";

                        $body  = "<td>\n";

                        $values = $data->getPropertyValues( $diProperty );
                        
                        if ( $incoming && ( count( $values ) >= SMWSpecialBrowse::$incomingvaluescount ) ) {
                                $moreIncoming = true;
                                array_pop( $values );
                        } else {
                                $moreIncoming = false;
                        }
                        
                        $first = true;
                        foreach ( $values as /* SMWDataItem */ $di ) {
                                if ( $first ) {
                                        $first = false;
                                } else {
                                        $body .= ', ';
                                }

                                if ( $incoming ) {
                                        $dv = SMWDataValueFactory::newDataItemValue( $di, null );
                                } else {
                                        $dv = SMWDataValueFactory::newDataItemValue( $di, $diProperty );
                                }
                                
                                $body .= "<span class=\"{$ccsPrefix}value\">" .
                                         $this->displayValue( $dvProperty, $dv, $incoming ) . "</span>\n";
                        }

                        if ( $moreIncoming ) { // link to the remaining incoming pages:
                                $body .= Html::element(
                                        'a',
                                        array(
                                                'href' => SpecialPage::getSafeTitleFor( 'SearchByProperty' )->getLocalURL( array(
                                                         'property' => $dvProperty->getWikiValue(),
                                                         'value' => $this->subject->getWikiValue()
                                                ) )
                                        ),
                                        wfMsg( 'smw_browse_more' )
                                );

                        }

                        $body .= "</td>\n";

                        // display row
                        $html .= "<tr class=\"{$ccsPrefix}propvalue\">\n" .
                                        ( $left ? ( $head . $body ):( $body . $head ) ) . "</tr>\n";
                        $noresult = false;
                } // end foreach properties

                if ( $noresult ) {
                        $html .= "<tr class=\"smwb-propvalue\"><th> &#160; </th><td><em>" .
                                 wfMsg( $incoming ? 'smw_browse_no_incoming':'smw_browse_no_outgoing' ) . "</em></td></tr>\n";
                }
                $html .= "</table>\n";
                return $html;
        }

        private function displayValue( SMWPropertyValue $property, SMWDataValue $dataValue, $incoming ) {
                $linker = smwfGetLinker();

                $html = $dataValue->getLongHTMLText( $linker );

                if ( $dataValue->getTypeID() == '_wpg' ) {
                        $html .= "&#160;" . SMWInfolink::newBrowsingLink( '+', $dataValue->getLongWikiText() )->getHTML( $linker );
                } elseif ( $incoming && $property->isVisible() ) {
                        $html .= "&#160;" . SMWInfolink::newInversePropertySearchLink( '+', $dataValue->getTitle(), $property->getDataItem()->getLabel(), 'smwsearch' )->getHTML( $linker );
                } else {
                        $html .= $dataValue->getInfolinkText( SMW_OUTPUT_HTML, $linker );
                }

                return $html;
        }

        private function displayHead() {
                global $wgOut;

                $wgOut->setHTMLTitle( $this->subject->getTitle() );
                $html = "<table class=\"smwb-factbox\" cellpadding=\"0\" cellspacing=\"0\">\n" .
                        "<tr class=\"smwb-title\"><td colspan=\"2\">\n" .
                        $this->subject->getLongHTMLText( smwfGetLinker() ) . "\n" .
                        "</td></tr>\n</table>\n";

                return $html;
         }

        private function displayCenter() {
                return "<a name=\"smw_browse_incoming\"></a>\n" .
                       "<table class=\"smwb-factbox\" cellpadding=\"0\" cellspacing=\"0\">\n" .
                       "<tr class=\"smwb-center\"><td colspan=\"2\">\n" .
                       ( $this->showincoming ?
                             $this->linkHere( wfMsg( 'smw_browse_hide_incoming' ), true, false, 0 ):
                         $this->linkHere( wfMsg( 'smw_browse_show_incoming' ), true, true, $this->offset ) ) .
                       "&#160;\n" . "</td></tr>\n" . "</table>\n";
        }

        private function displayBottom( $more ) {
                $html  = "<table class=\"smwb-factbox\" cellpadding=\"0\" cellspacing=\"0\">\n" .
                         "<tr class=\"smwb-center\"><td colspan=\"2\">\n";
                global $smwgBrowseShowAll;
                if ( !$smwgBrowseShowAll ) {
                        if ( ( $this->offset > 0 ) || $more ) {
                                $offset = max( $this->offset - SMWSpecialBrowse::$incomingpropertiescount + 1, 0 );
                                $html .= ( $this->offset == 0 ) ? wfMsg( 'smw_result_prev' ):
                                             $this->linkHere( wfMsg( 'smw_result_prev' ), $this->showoutgoing, true, $offset );
                                $offset = $this->offset + SMWSpecialBrowse::$incomingpropertiescount - 1;
                                $html .= " &#160;&#160;&#160;  <strong>" . wfMsg( 'smw_result_results' ) . " " . ( $this->offset + 1 ) .
                                                 " – " . ( $offset ) . "</strong>  &#160;&#160;&#160; ";
                                $html .= $more ? $this->linkHere( wfMsg( 'smw_result_next' ), $this->showoutgoing, true, $offset ):wfMsg( 'smw_result_next' );
                        }
                }
                $html .= "&#160;\n" . "</td></tr>\n" . "</table>\n";
                return $html;
        }

        private function linkHere( $text, $out, $in, $offset ) {
                $frag = ( $text == wfMsg( 'smw_browse_show_incoming' ) ) ? '#smw_browse_incoming' : '';

                return Html::element(
                        'a',
                        array(
                                'href' => SpecialPage::getSafeTitleFor( 'Browse' )->getLocalURL( array(
                                        'offset' => $offset,
                                        'dir' => $out ? ( $in ? 'both' : 'out' ) : 'in',
                                        'article' => $this->subject->getLongWikiText()
                                ) ) . $frag
                        ),
                        $text
                );
        }

        private function getInData() {
                $indata = new SMWSemanticData( $this->subject->getDataItem() );
                $options = new SMWRequestOptions();
                $options->sort = true;
                $options->limit = SMWSpecialBrowse::$incomingpropertiescount;
                if ( $this->offset > 0 ) $options->offset = $this->offset;

                $inproperties = smwfGetStore()->getInProperties( $this->subject->getDataItem(), $options );

                if ( count( $inproperties ) == SMWSpecialBrowse::$incomingpropertiescount ) {
                        $more = true;
                        array_pop( $inproperties ); // drop the last one
                } else {
                        $more = false;
                }

                $valoptions = new SMWRequestOptions();
                $valoptions->sort = true;
                $valoptions->limit = SMWSpecialBrowse::$incomingvaluescount;

                foreach ( $inproperties as $property ) {
                        $values = smwfGetStore()->getPropertySubjects( $property, $this->subject->getDataItem(), $valoptions );
                        foreach ( $values as $value ) {
                                $indata->addPropertyObjectValue( $property, $value );
                        }
                }

                return array( $indata, $more );
        }

        private function getPropertyLabel( SMWPropertyValue $property, $incoming = false ) {
                global $smwgBrowseShowInverse;

                if ( $incoming && $smwgBrowseShowInverse ) {
                        $oppositeprop = SMWPropertyValue::makeUserProperty( wfMsg( 'smw_inverse_label_property' ) );
                        $labelarray = &smwfGetStore()->getPropertyValues( $property->getDataItem()->getDiWikiPage(), $oppositeprop->getDataItem() );
                        $rv = ( count( $labelarray ) > 0 ) ? $labelarray[0]->getLongWikiText():
                               wfMsg( 'smw_inverse_label_default', $property->getWikiValue() );
                } else {
                        $rv = $property->getWikiValue();
                }

                return $this->unbreak( $rv );
        }

        private function queryForm() {
                self::addAutoComplete();
                $title = SpecialPage::getTitleFor( 'Browse' );
                return '  <form name="smwbrowse" action="' . htmlspecialchars( $title->getLocalURL() ) . '" method="get">' . "\n" .
                       '    <input type="hidden" name="title" value="' . $title->getPrefixedText() . '"/>' .
                       wfMsg( 'smw_browse_article' ) . "<br />\n" .
                       '    <input type="text" name="article" id="page_input_box" value="' . htmlspecialchars( $this->articletext ) . '" />' . "\n" .
                       '    <input type="submit" value="' . wfMsg( 'smw_browse_go' ) . "\"/>\n" .
                       "  </form>\n";
        }

        private static function addAutoComplete() {
                SMWOutputs::requireResource( 'jquery.ui.autocomplete' );

                $javascript_autocomplete_text = <<<END
<script type="text/javascript">
jQuery(document).ready(function(){
        jQuery("#page_input_box").autocomplete({
                minLength: 3,
                source: function(request, response) {
                        jQuery.getJSON(wgScriptPath+'/api.php?action=opensearch&limit=10&namespace=0&format=jsonfm&search='+request.term, function(data){
                                response(data[1]);
                        });
                }
        });
});
</script>

END;

                SMWOutputs::requireScript( 'smwAutocompleteSpecialBrowse', $javascript_autocomplete_text );
        }

        private function unbreak( $text ) {
                $nonBreakingSpace = html_entity_decode( '&#160;', ENT_NOQUOTES, 'UTF-8' );
                $text = preg_replace( '/[\s]/u', $nonBreakingSpace, $text, - 1, $count );
                return $count > 2 ? preg_replace( '/($nonBreakingSpace)/u', ' ', $text, max( 0, $count - 2 ) ):$text;
        }

}

---