SemanticResultFormats/iCalendar/SRF_iCalendar.php

Go to the documentation of this file.

<?php
class SRFiCalendar extends SMWResultPrinter {
        
        protected $m_title;
        protected $m_description;

        protected function handleParameters( array $params, $outputmode ) {
                parent::handleParameters( $params, $outputmode );
                
                $this->m_title = trim( $params['title'] );
                $this->m_description = trim( $params['description'] );
        }

        public function getMimeType( $res ) {
                return 'text/calendar';
        }

        public function getFileName( $res ) {
                if ( $this->m_title != '' ) {
                        return str_replace( ' ', '_', $this->m_title ) . '.ics';
                } else {
                        return 'iCalendar.ics';
                }
        }

        public function getQueryMode( $context ) {
                return ( $context == SMWQueryProcessor::SPECIAL_PAGE ) ? SMWQuery::MODE_INSTANCES : SMWQuery::MODE_NONE;
        }

        public function getName() {
                return wfMsg( 'srf_printername_icalendar' );
        }

        protected function getResultText( SMWQueryResult $res, $outputmode ) {
                return $outputmode == SMW_OUTPUT_FILE ? $this->getIcal( $res ) : $this->getIcalLink( $res, $outputmode );
        }
        
        protected function getIcal( SMWQueryResult $res ) {
                $result = '';
                
                if ( $this->m_title == '' ) {
                        global $wgSitename;
                        $this->m_title = $wgSitename;
                }
                
                $result .= "BEGIN:VCALENDAR\r\n";
                $result .= "PRODID:-//SMW Project//Semantic Result Formats\r\n";
                $result .= "VERSION:2.0\r\n";
                $result .= "METHOD:PUBLISH\r\n";
                $result .= "X-WR-CALNAME:" . $this->m_title . "\r\n";
                
                if ( $this->m_description !== '' ) {
                        $result .= "X-WR-CALDESC:" . $this->m_description . "\r\n";
                }
                
                // TODO: http://www.kanzaki.com/docs/ical/vtimezone.html
                // $result .= "BEGIN:VTIMEZONE\r\n";
                // $result .= "TZID:\r\n";

                $row = $res->getNext();
                while ( $row !== false ) {
                        $result .= $this->getIcalForItem( $row );
                        $row = $res->getNext();
                }
                
                // $result .= "END:VTIMEZONE\r\n";
                
                $result .= "END:VCALENDAR\r\n";

                return $result;
        }

        protected function getIcalLink( SMWQueryResult $res, $outputmode ) {
                if ( $this->getSearchLabel( $outputmode ) ) {
                        $label = $this->getSearchLabel( $outputmode );
                } else {
                        $label = wfMsgForContent( 'srf_icalendar_link' );
                }
                
                $link = $res->getQueryLink( $label );
                $link->setParameter( 'icalendar', 'format' );
                
                if ( $this->m_title !== '' ) {
                        $link->setParameter( $this->m_title, 'title' );
                }
                
                if ( $this->m_description !== '' ) {
                        $link->setParameter( $this->m_description, 'description' );
                }
                
                if ( array_key_exists( 'limit', $this->params ) ) {
                        $link->setParameter( $this->params['limit'], 'limit' );
                } else { // use a reasonable default limit
                        $link->setParameter( 20, 'limit' );
                }

                // yes, our code can be viewed as HTML if requested, no more parsing needed
                $this->isHTML = ( $outputmode == SMW_OUTPUT_HTML ); 
                return $link->getText( $outputmode, $this->mLinker );
        }
        
        protected function getIcalForItem( array $row ) {
                $result = '';
                
                $wikipage = $row[0]->getResultSubject(); // get the object
                $wikipage = SMWDataValueFactory::newDataItemValue( $wikipage, null );
                
                $startdate = false;
                $enddate = false;
                
                $params = array(
                        'summary' => $wikipage->getShortWikiText()
                );
                
                foreach ( $row as /* SMWResultArray */ $field ) {
                        // later we may add more things like a generic
                        // mechanism to add whatever you want :)
                        // could include funny things like geo, description etc. though
                        $req = $field->getPrintRequest();
                        $label = strtolower( $req->getLabel() );
                        
                        switch ( $label ) {
                                case 'start': case 'end':
                                        if ( $req->getTypeID() == '_dat' ) {
                                                $params[$label] = $field->getNextDataValue();
                                        }
                                        break;
                                case 'location': case 'description': case 'summary':
                                        $value = $field->getNextDataValue();
                                        if ( $value !== false ) {
                                                $params[$label] = $value->getShortWikiText();
                                        }
                                        break;
                        }
                }
                
                $title = $wikipage->getTitle();
                $article = new Article( $title );
                $url = $title->getFullURL();
                
                $result .= "BEGIN:VEVENT\r\n";
                $result .= "SUMMARY:" . $params['summary'] . "\r\n";
                $result .= "URL:$url\r\n";
                $result .= "UID:$url\r\n";
                
                if ( array_key_exists( 'start', $params ) ) $result .= "DTSTART:" . $this->parsedate( $params['start'] ) . "\r\n";
                if ( array_key_exists( 'end', $params ) )   $result .= "DTEND:" . $this->parsedate( $params['end'], true ) . "\r\n";
                if ( array_key_exists( 'location', $params ) )  $result .= "LOCATION:" . $params['location'] . "\r\n";
                if ( array_key_exists( 'description', $params ) )  $result .= "DESCRIPTION:" . $params['description'] . "\r\n";
                
                $t = strtotime( str_replace( 'T', ' ', $article->getTimestamp() ) );
                $result .= "DTSTAMP:" . date( "Ymd", $t ) . "T" . date( "His", $t ) . "\r\n";
                $result .= "SEQUENCE:" . $title->getLatestRevID() . "\r\n";
                $result .= "END:VEVENT\r\n";
                
                return $result;
        }

        static private function parsedate( SMWTimeValue $dv, $isend = false ) {
                $year = $dv->getYear();
                if ( ( $year > 9999 ) || ( $year < -9998 ) ) return ''; // ISO range is limited to four digits
                
                $year = number_format( $year, 0, '.', '' );
                $time = str_replace( ':', '', $dv->getTimeString( false ) );
                
                if ( ( $time == false ) && ( $isend ) ) { // increment by one day, compute date to cover leap years etc.
                        $dv = SMWDataValueFactory::newTypeIDValue( '_dat', $dv->getWikiValue() . 'T00:00:00-24:00' );
                }
                
                $month = $dv->getMonth();
                if ( strlen( $month ) == 1 ) $month = '0' . $month;
                
                $day = $dv->getDay();
                if ( strlen( $day ) == 1 ) $day = '0' . $day;
                
                $result = $year . $month . $day;
                
                if ( $time != false ) $result .= "T$time";
                
                return $result;
        }

        public function getParameters() {
                $params = array_merge( parent::getParameters(), $this->exportFormatParameters() );
                
                $params['title'] = new Parameter( 'title' );
                $params['title']->setMessage( 'srf_paramdesc_icalendartitle' );
                $params['title']->setDefault( '' );
                
                $params['description'] = new Parameter( 'description' );
                $params['description']->setMessage( 'srf_paramdesc_icalendardescription' );
                $params['description']->setDefault( '' );
                
                return $params;
        }

}

---