SemanticResultFormats/Calendar/SRF_Calendar.php

Go to the documentation of this file.

<?php

$wgAutoloadClasses['SRFCHistoricalDate'] = dirname( __FILE__ ) . '/SRFC_HistoricalDate.php';

class SRFCalendar extends SMWResultPrinter {

        protected $mTemplate;
        protected $mUserParam;
        protected $mRealUserLang = null;

        protected function setColors( $colorsText ) {
                $colors = array();
                $colorElements = explode( ',', $colorsText );
                foreach ( $colorElements as $colorElem ) {
                        $propAndColor = explode( '=>', $colorElem );
                        if ( count( $propAndColor ) == 2 ) {
                                $colors[$propAndColor[0]] = $propAndColor[1];
                        }
                }
                $this->mColors = $colors;
        }

        protected function handleParameters( array $params, $outputmode ) {
                parent::handleParameters( $params, $outputmode );

                $this->mTemplate = trim( $params['template'] );
                $this->mUserParam = trim( $params['userparam'] );

                if ( $params['lang'] !== false ) {
                        global $wgLang;
                        // Store the actual user's language, so we can revert
                        // back to it after printing the calendar.
                        $this->mRealUserLang = clone ( $wgLang );
                        $wgLang = Language::factory( trim( $params['lang'] ) );
                }

                $this->setColors( $params['colors'] );
        }

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

        public function getResult( SMWQueryResult $results, array $params, $outputmode ) {
                $this->isHTML = false;
                $this->hasTemplates = false;

                // Skip checks - results with 0 entries are normal.
                $this->handleParameters( $params, $outputmode );
                return $this->getResultText( $results, SMW_OUTPUT_HTML );
        }

        protected function getResultText( SMWQueryResult $res, $outputmode ) {
                $events = array();

                // Print all result rows.
                while ( $row = $res->getNext() ) {
                        $dates = array();
                        $title = $text = $color = '';

                        if ( $this->mTemplate != '' ) {
                                // Build template code
                                $this->hasTemplates = true;

                                if ( $this->mUserParam ) {
                                        $text = "|userparam=$this->mUserParam";
                                }

                                foreach ( $row as $i => $field ) {
                                        $pr = $field->getPrintRequest();
                                        $text .= '|' . ( $i + 1 ) . '=';

                                        while ( ( $object = $field->getNextDataValue() ) !== false ) {
                                                if ( $object->getTypeID() == '_dat' ) {
                                                        $text .= $object->getLongWikiText();
                                                } elseif ( $object->getTypeID() == '_wpg' ) { // use shorter "LongText" for wikipage
                                                        // handling of "link=" param
                                                        if ( $this->mLinkOthers ) {
                                                                $text .= $object->getLongText( $outputmode, null );
                                                        } else {
                                                                $text .= $object->getWikiValue();
                                                        }
                                                } else {
                                                        $text .= $object->getShortText( $outputmode, null );
                                                }

                                                if ( $pr->getMode() == SMWPrintRequest::PRINT_PROP && $pr->getTypeID() == '_dat' ) {
                                                        $dates[] = $this->formatDateStr( $object );
                                                }
                                        }
                                }
                        } else {
                                // Build simple text.
                                $numNonDateProperties = 0;
                                // Cycle through a 'row', which is the page
                                // name (the first field) plus all its
                                // properties.
                                foreach ( $row as $i => $field ) {
                                        $pr = $field->getPrintRequest();
                                        // A property can have more than one
                                        // value - cycle through all the values
                                        // for this property.
                                        $textForProperty = '';

                                        while ( ( $object = $field->getNextDataValue() ) !== false ) {
                                                if ( $object->getTypeID() == '_dat' ) {
                                                        // Don't add date values to the display.
                                                } elseif ( $object->getTypeID() == '_wpg' ) { // use shorter "LongText" for wikipage
                                                        if ( $i == 0 ) {
                                                                $title = Title::newFromText( $object->getShortWikiText( false ) );
                                                        } else {
                                                                $numNonDateProperties++;

                                                                // handling of "headers=" param
                                                                if ( $this->mShowHeaders == SMW_HEADERS_SHOW ) {
                                                                        $textForProperty .= $pr->getHTMLText( smwfGetLinker() ) . ' ';
                                                                } elseif ( $this->mShowHeaders == SMW_HEADERS_PLAIN ) {
                                                                        $textForProperty .= $pr->getLabel() . ' ';
                                                                }

                                                                // If $this->mShowHeaders == SMW_HEADERS_HIDE, print nothing.
                                                                // handling of "link=" param
                                                                if ( $this->mLinkOthers ) {
                                                                        $textForProperty .= $object->getLongText( $outputmode, smwfGetLinker() );
                                                                } else {
                                                                        $textForProperty .= $object->getWikiValue();
                                                                }
                                                        }
                                                } else {
                                                        $numNonDateProperties++;
                                                        $textForProperty .= $pr->getHTMLText( smwfGetLinker() ) . ' ' . $object->getShortText( $outputmode, smwfGetLinker() );
                                                }
                                                if ( $pr->getMode() == SMWPrintRequest::PRINT_PROP && $pr->getTypeID() == '_dat' ) {
                                                        $datePropLabel = $pr->getLabel();
                                                        if ( !array_key_exists( $datePropLabel, $dates ) ) {
                                                                $dates[$datePropLabel] = array();
                                                        }
                                                        $dates[$datePropLabel][] = $this->formatDateStr( $object );
                                                }
                                        }

                                        // Add the text for this property to
                                        // the main text, adding on parentheses
                                        // or commas as needed.
                                        if ( $numNonDateProperties == 1 ) {
                                                $text .= ' (';
                                        } elseif ( $numNonDateProperties > 1 ) {
                                                $text .= ', ';
                                        }
                                        $text .= $textForProperty;
                                }
                                if ( $numNonDateProperties > 0 ) {
                                        $text .= ')';
                                }
                        }

                        if ( count( $dates ) > 0 ) {
                                // Handle the 'color=' value, whether it came
                                // from a compound query or a regular one.
                                $res_subject = $field->getResultSubject();
                                if ( isset( $res_subject->display_options )
                                        && is_array( $res_subject->display_options ) ) {
                                        if ( array_key_exists( 'color', $res_subject->display_options ) ) {
                                                $color = $res_subject->display_options['color'];
                                        }
                                        if ( array_key_exists( 'colors', $res_subject->display_options ) ) {
                                                $this->setColors( $res_subject->display_options['colors'] );
                                        }
                                }

                                foreach ( $dates as $label => $datesForLabel ) {
                                        foreach ( $datesForLabel as $date ) {
                                                $curText = $text;
                                                // If there's more than one
                                                // label, i.e. more than one
                                                // date property being displayed,
                                                // show the name of the current
                                                // property in parentheses.
                                                if ( count( $dates ) > 1 ) {
                                                        $curText = "($label) " . $curText;
                                                }
                                                $curColor = $color;
                                                if ( array_key_exists( $label, $this->mColors ) ) {
                                                        $curColor = $this->mColors[$label];
                                                }
                                                $events[] = array( $title, $curText, $date, $curColor );
                                        }
                                }
                        }
                }

                $result = $this->displayCalendar( $events );

                // Go back to the actual user's language, in case a different
                // language had been specified for this calendar.
                if ( ! is_null( $this->mRealUserLang ) ) {
                        global $wgLang;
                        $wgLang = $this->mRealUserLang;
                }

                global $wgParser;

                if ( is_null( $wgParser->getTitle() ) ) {
                        return $result;
                } else {
                        return array( $result, 'noparse' => 'true', 'isHTML' => 'true' );
                }
        }

        protected static function intToMonth( $int ) {
                $months = array(
                        '1' => 'january',
                        '2' => 'february',
                        '3' => 'march',
                        '4' => 'april',
                        '5' => 'may_long',
                        '6' => 'june',
                        '7' => 'july',
                        '8' => 'august',
                        '9' => 'september',
                        '10' => 'october',
                        '11' => 'november',
                        '12' => 'december',
                );

                return wfMsgForContent( array_key_exists( $int, $months ) ? $months[$int] : 'january' ); 
        }

        function formatDateStr( $object ) {
                // For some reason, getMonth() and getDay() sometimes return a
                // number with a leading zero - get rid of it using (int)
                return $object->getYear() . '-' . (int)$object->getMonth() . '-' . (int)$object->getDay();
        }

        function displayCalendar( $events ) {
                global $wgOut, $srfgScriptPath, $wgParser, $wgRequest;
                global $srfgFirstDayOfWeek;

                $wgParser->disableCache();

                $wgOut->addLink( array(
                        'rel' => 'stylesheet',
                        'type' => 'text/css',
                        'media' => 'screen, print',
                        'href' => $srfgScriptPath . '/Calendar/skins/SRFC_main.css'
                ) );

                // Set variables differently depending on whether this is
                // being called from a regular page, via #ask, or from a
                // special page: most likely either Special:Ask or
                // Special:RunQuery.
                $page_title = $wgParser->getTitle();
                $additional_query_string = '';
                $hidden_inputs = '';
                $in_special_page = is_null( $page_title ) || $page_title->isSpecialPage();

                if ( $in_special_page ) {
                        global $wgTitle;
                        $page_title = $wgTitle;
                        global $wgUser;
                        $skin = $wgUser->getSkin();
                        $request_values = $wgRequest->getValues();
                        // Also go through the predefined PHP variable
                        // $_REQUEST, because $wgRequest->getValues() for
                        // some reason doesn't return array values - is
                        // there a better (less hacky) way to do this?
                        foreach ( $_REQUEST as $key => $value ) {
                                if ( is_array( $value ) ) {
                                        foreach ($value as $k2 => $v2 ) {
                                                $new_key = $key . '[' . $k2 . ']';
                                                $request_values[$new_key] = $v2;
                                        }
                                }
                        }

                        foreach ( $request_values as $key => $value ) {
                                if ( $key != 'month' && $key != 'year'
                                        // values from 'RunQuery'
                                        && $key != 'query' && $key != 'free_text'
                                ) {
                                        $additional_query_string .= "&$key=$value";
                                        $hidden_inputs .= "<input type=\"hidden\" name=\"$key\" value=\"$value\" />";
                                }
                        }
                } else {
                        $skin = $wgParser->getOptions()->getSkin();
                }

                // Set days of the week.
                $week_day_names = array(
                        1 => wfMsg( 'sunday' ),
                        2 => wfMsg( 'monday' ),
                        3 => wfMsg( 'tuesday' ),
                        4 => wfMsg( 'wednesday' ),
                        5 => wfMsg( 'thursday' ),
                        6 => wfMsg( 'friday' ),
                        7 => wfMsg( 'saturday' )
                );
                if ( empty( $srfgFirstDayOfWeek ) ) {
                        $firstDayOfWeek = 1;
                        $lastDayOfWeek = 7;
                } else {
                        $firstDayOfWeek = array_search( $srfgFirstDayOfWeek, $week_day_names );
                        if ( $firstDayOfWeek === false ) {
                                // Bad value for $srfgFirstDayOfWeek!
                                print 'Warning: Bad value for $srfgFirstDayOfWeek ("' . $srfgFirstDayOfWeek . '")';
                                $firstDayOfWeek = 1;
                        }
                        if ( $firstDayOfWeek == 1 ) {
                                $lastDayOfWeek = 7;
                        } else {
                                $lastDayOfWeek = $firstDayOfWeek - 1;
                        }
                }

                // Now create the actual array of days of the week, based on
                // the start day
                $week_days = array();
                for ( $i = 1; $i <= 7; $i++ ) {
                        $curDay = ( ( $firstDayOfWeek + $i - 2 ) % 7 ) + 1;
                        $week_days[$i] = $week_day_names[$curDay];
                }

                // Get all the date-based values we need - the current month
                // and year (i.e., the one the user is looking at - not
                // necessarily the "current" ones), the previous and next months
                // and years (same - note that the previous or next month could
                // be in a different year), the number of days in the current,
                // previous and next months, etc.
                $cur_month_num = date( 'n', time() );
                if ( $wgRequest->getCheck( 'month' ) ) {
                        $query_month = $wgRequest->getVal( 'month' );
                        if ( is_numeric( $query_month ) && ( intval( $query_month ) == $query_month ) && $query_month >= 1 && $query_month <= 12 ) {
                                $cur_month_num = $wgRequest->getVal( 'month' );
                        }
                }

                $cur_month = self::intToMonth( $cur_month_num );
                $cur_year = date( 'Y', time() );
                if ( $wgRequest->getCheck( 'year' ) ) {
                        $query_year = $wgRequest->getVal( 'year' );
                        if ( is_numeric( $query_year ) && intval( $query_year ) == $query_year ) {
                                $cur_year = $wgRequest->getVal( 'year' );
                        }
                }

                if ( $cur_month_num == '1' ) {
                        $prev_month_num = '12';
                        $prev_year = $cur_year - 1;
                } else {
                        $prev_month_num = $cur_month_num - 1;
                        $prev_year = $cur_year;
                }

                if ( $cur_month_num == '12' ) {
                        $next_month_num = '1';
                        $next_year = $cur_year + 1;
                } else {
                        $next_month_num = $cur_month_num + 1;
                        $next_year = $cur_year;
                }

                // There's no year '0' - change it to '1' or '-1'.
                if ( $cur_year == '0' ) { $cur_year = '1'; }
                if ( $next_year == '0' ) { $next_year = '1'; }
                if ( $prev_year == '0' ) { $prev_year = '-1'; }

                $prev_month_url = $page_title->getLocalURL( "month=$prev_month_num&year=$prev_year" . $additional_query_string );
                $next_month_url = $page_title->getLocalURL( "month=$next_month_num&year=$next_year" . $additional_query_string );
                $today_url = $page_title->getLocalURL( $additional_query_string );

                $today_text = wfMsg( 'srfc_today' );
                $prev_month_text = wfMsg( 'srfc_previousmonth' );
                $next_month_text = wfMsg( 'srfc_nextmonth' );
                $go_to_month_text = wfMsg( 'srfc_gotomonth' );

                // Get day of the week that the first of this month falls on.
                $first_day = new SRFCHistoricalDate();
                $first_day->create( $cur_year, $cur_month_num, 1 );
                $day_of_week_of_1 = $first_day->getDayOfWeek();
                $start_day = $firstDayOfWeek - $day_of_week_of_1;
                if ( $start_day > 0 ) { $start_day -= 7; }
                $days_in_prev_month = SRFCHistoricalDate::daysInMonth( $prev_year, $prev_month_num );
                $days_in_cur_month = SRFCHistoricalDate::daysInMonth( $cur_year, $cur_month_num );
                $today_string = date( 'Y n j', time() );
                $page_name = $page_title->getPrefixedDbKey();

                // Create table for holding title and navigation information.
                $text = <<<END
<table class="navigation_table">
<tr>
<td class="month_name">$cur_month $cur_year</td>
<td class="nav_links">
<a href="$prev_month_url" title="$prev_month_text"><img src="$srfgScriptPath/Calendar/skins/left-arrow.png" border="0" /></a>
&#160;
<a href="$today_url">$today_text</a>
&#160;
<a href="$next_month_url" title="$next_month_text"><img src="$srfgScriptPath/Calendar/skins/right-arrow.png" border="0" /></a>
</td>
<td class="nav_form">
<form>
<input type="hidden" name="title" value="$page_name">
<select name="month">

END;
                for ( $i = 1; $i <= 12; $i++ ) {
                        $month_name = self::intToMonth( $i );
                        $selected_str = ( $i == $cur_month_num ) ? "selected" : "";
                        $text .= "<option value=\"$i\" $selected_str>$month_name</option>\n";
                }
                $text .= <<<END
</select>
<input name="year" type="text" value="$cur_year" size="4">
$hidden_inputs
<input type="submit" value="$go_to_month_text">
</form>
</td>
</tr>
</table>

<table class="month_calendar">
<tr class="weekdays">

END;
                // First row of the main table holds the days of the week
                foreach ( $week_days as $week_day ) {
                        $text .= "<td>$week_day</td>";
                }
                $text .= "</tr>\n";

                // Now, create the calendar itself -
                // loop through a set of weeks, from a "Sunday" (which might be
                // before the beginning of the month) to a "Saturday" (which
                // might be after the end of the month).
                // "Sunday" and "Saturday" are in quotes because the actual
                // start and end days of the week can be set by the admin.
                $day_of_the_week = $firstDayOfWeek;
                $is_last_week = false;
                for ( $day = $start_day; ( ! $is_last_week || $day_of_the_week != $firstDayOfWeek ); $day++ ) {
                        if ( $day_of_the_week == $firstDayOfWeek ) {
                                $text .= "<tr>\n";
                        }
                        if ( "$cur_year $cur_month_num $day" == $today_string ) {
                                $text .= "<td class=\"today\">\n";
                        } elseif ( $day_of_the_week == 1 || $day_of_the_week == 7 ) {
                                $text .= "<td class=\"weekend_day\">\n";
                        } else {
                                $text .= "<td>\n";
                        }
                        if ( $day == $days_in_cur_month || $day > 50 ) { $is_last_week = true; }
                        // If this day is before or after the current month,
                        // set a "display day" to show on the calendar, and
                        // use a different CSS style for it.
                        if ( $day > $days_in_cur_month || $day < 1 ) {
                                if ( $day < 1 ) {
                                        $display_day = $day + $days_in_prev_month;
                                        $date_str = $prev_year . '-' . $prev_month_num . '-' . $display_day;
                                }
                                if ( $day > $days_in_cur_month ) {
                                        $display_day = $day - $days_in_cur_month;
                                        $date_str = $next_year . '-' . $next_month_num . '-' . $display_day;
                                }
                                $text .= "<div class=\"day day_other_month\">$display_day</div>\n";
                        } else {
                                $date_str = $cur_year . '-' . $cur_month_num . '-' . $day;
                                $text .= "<div class=\"day\">$day</div>\n";
                        }
                        // Finally, the most important step - get the events
                        // that match this date, and the given set of criteria,
                        // and display them in this date's box.
                        $text .= "<div class=\"main\">\n";
                        if ( $events == null ) {
                                $events = array();
                        }
                        foreach ( $events as $event ) {
                                list( $event_title, $other_text, $event_date, $color ) = $event;
                                if ( $event_date == $date_str ) {
                                        if ( $this->mTemplate != '' ) {
                                                $templatetext = '{{' . $this->mTemplate . $other_text . '|thisdate=' . $date_str . '}}';
                                                $templatetext = $wgParser->replaceVariables( $templatetext );
                                                $templatetext = $wgParser->recursiveTagParse( $templatetext );
                                                $text .= $templatetext;
                                        } else {
                                                $event_str = $skin->makeLinkObj( $event_title );
                                                if ( $color != '' ) {
                                                        $text .= "<div class=\"colored-entry\"><p style=\"border-left: 7px $color solid;\">$event_str $other_text</p></div>\n";
                                                } else {
                                                        $text .= "$event_str $other_text\n\n";
                                                }
                                        }
                                }
                        }
                        $text .= <<<END
</div>
</td>

END;
                        if ( $day_of_the_week == $lastDayOfWeek ) {
                                $text .= "</tr>\n";
                        }
                        if ( $day_of_the_week == 7 ) {
                                $day_of_the_week = 1;
                        } else {
                                $day_of_the_week++;
                        }
                }
                $text .= "</table>\n";

                return $text;
        }

        public function getParameters() {
                $params = parent::getParameters();

                $params['lang'] = new Parameter( 'lang' );
                $params['lang']->setMessage( 'srf_paramdesc_calendarlang' );
                $params['lang']->setDefault( false, false );

                $params['template'] = new Parameter( 'template' );
                $params['template']->setDefault( '' );

                $params['userparam'] = new Parameter( 'userparam' );
                $params['userparam']->setDefault( '' );

                $params['color'] = new Parameter( 'color' );
                $params['color']->setDefault( '' );

                $params['colors'] = new Parameter( 'colors' );
                $params['colors']->setMessage( 'srf_paramdesc_calendarcolors' );
                $params['colors']->setDefault( '' );

                return $params;
        }

}

---