wikimedia /
mediawiki
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Preferences often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Preferences, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 50 | class Preferences { |
||
| 51 | /** @var array */ |
||
| 52 | protected static $defaultPreferences = null; |
||
| 53 | |||
| 54 | /** @var array */ |
||
| 55 | protected static $saveFilters = [ |
||
| 56 | 'timecorrection' => [ 'Preferences', 'filterTimezoneInput' ], |
||
| 57 | 'cols' => [ 'Preferences', 'filterIntval' ], |
||
| 58 | 'rows' => [ 'Preferences', 'filterIntval' ], |
||
| 59 | 'rclimit' => [ 'Preferences', 'filterIntval' ], |
||
| 60 | 'wllimit' => [ 'Preferences', 'filterIntval' ], |
||
| 61 | 'searchlimit' => [ 'Preferences', 'filterIntval' ], |
||
| 62 | ]; |
||
| 63 | |||
| 64 | // Stuff that shouldn't be saved as a preference. |
||
| 65 | private static $saveBlacklist = [ |
||
| 66 | 'realname', |
||
| 67 | 'emailaddress', |
||
| 68 | ]; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * @return array |
||
| 72 | */ |
||
| 73 | static function getSaveBlacklist() { |
||
| 74 | return self::$saveBlacklist; |
||
| 75 | } |
||
| 76 | |||
| 77 | /** |
||
| 78 | * @throws MWException |
||
| 79 | * @param User $user |
||
| 80 | * @param IContextSource $context |
||
| 81 | * @return array|null |
||
| 82 | */ |
||
| 83 | static function getPreferences( $user, IContextSource $context ) { |
||
| 84 | if ( self::$defaultPreferences ) { |
||
| 85 | return self::$defaultPreferences; |
||
| 86 | } |
||
| 87 | |||
| 88 | $defaultPreferences = []; |
||
| 89 | |||
| 90 | self::profilePreferences( $user, $context, $defaultPreferences ); |
||
| 91 | self::skinPreferences( $user, $context, $defaultPreferences ); |
||
| 92 | self::datetimePreferences( $user, $context, $defaultPreferences ); |
||
| 93 | self::filesPreferences( $user, $context, $defaultPreferences ); |
||
| 94 | self::renderingPreferences( $user, $context, $defaultPreferences ); |
||
| 95 | self::editingPreferences( $user, $context, $defaultPreferences ); |
||
| 96 | self::rcPreferences( $user, $context, $defaultPreferences ); |
||
| 97 | self::watchlistPreferences( $user, $context, $defaultPreferences ); |
||
| 98 | self::searchPreferences( $user, $context, $defaultPreferences ); |
||
| 99 | self::miscPreferences( $user, $context, $defaultPreferences ); |
||
| 100 | |||
| 101 | Hooks::run( 'GetPreferences', [ $user, &$defaultPreferences ] ); |
||
| 102 | |||
| 103 | self::loadPreferenceValues( $user, $context, $defaultPreferences ); |
||
| 104 | self::$defaultPreferences = $defaultPreferences; |
||
| 105 | return $defaultPreferences; |
||
| 106 | } |
||
| 107 | |||
| 108 | /** |
||
| 109 | * Loads existing values for a given array of preferences |
||
| 110 | * @throws MWException |
||
| 111 | * @param User $user |
||
| 112 | * @param IContextSource $context |
||
| 113 | * @param array $defaultPreferences Array to load values for |
||
| 114 | * @return array|null |
||
| 115 | */ |
||
| 116 | static function loadPreferenceValues( $user, $context, &$defaultPreferences ) { |
||
| 117 | # # Remove preferences that wikis don't want to use |
||
| 118 | foreach ( $context->getConfig()->get( 'HiddenPrefs' ) as $pref ) { |
||
| 119 | if ( isset( $defaultPreferences[$pref] ) ) { |
||
| 120 | unset( $defaultPreferences[$pref] ); |
||
| 121 | } |
||
| 122 | } |
||
| 123 | |||
| 124 | # # Make sure that form fields have their parent set. See bug 41337. |
||
| 125 | $dummyForm = new HTMLForm( [], $context ); |
||
| 126 | |||
| 127 | $disable = !$user->isAllowed( 'editmyoptions' ); |
||
| 128 | |||
| 129 | $defaultOptions = User::getDefaultOptions(); |
||
| 130 | # # Prod in defaults from the user |
||
| 131 | foreach ( $defaultPreferences as $name => &$info ) { |
||
| 132 | $prefFromUser = self::getOptionFromUser( $name, $info, $user ); |
||
| 133 | if ( $disable && !in_array( $name, self::$saveBlacklist ) ) { |
||
| 134 | $info['disabled'] = 'disabled'; |
||
| 135 | } |
||
| 136 | $field = HTMLForm::loadInputFromParameters( $name, $info, $dummyForm ); // For validation |
||
| 137 | $globalDefault = isset( $defaultOptions[$name] ) |
||
| 138 | ? $defaultOptions[$name] |
||
| 139 | : null; |
||
| 140 | |||
| 141 | // If it validates, set it as the default |
||
| 142 | if ( isset( $info['default'] ) ) { |
||
| 143 | // Already set, no problem |
||
| 144 | continue; |
||
| 145 | } elseif ( !is_null( $prefFromUser ) && // Make sure we're not just pulling nothing |
||
| 146 | $field->validate( $prefFromUser, $user->getOptions() ) === true ) { |
||
| 147 | $info['default'] = $prefFromUser; |
||
| 148 | } elseif ( $field->validate( $globalDefault, $user->getOptions() ) === true ) { |
||
| 149 | $info['default'] = $globalDefault; |
||
| 150 | } else { |
||
| 151 | throw new MWException( "Global default '$globalDefault' is invalid for field $name" ); |
||
| 152 | } |
||
| 153 | } |
||
| 154 | |||
| 155 | return $defaultPreferences; |
||
| 156 | } |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Pull option from a user account. Handles stuff like array-type preferences. |
||
| 160 | * |
||
| 161 | * @param string $name |
||
| 162 | * @param array $info |
||
| 163 | * @param User $user |
||
| 164 | * @return array|string |
||
| 165 | */ |
||
| 166 | static function getOptionFromUser( $name, $info, $user ) { |
||
| 167 | $val = $user->getOption( $name ); |
||
| 168 | |||
| 169 | // Handling for multiselect preferences |
||
| 170 | View Code Duplication | if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) || |
|
| 171 | ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) { |
||
| 172 | $options = HTMLFormField::flattenOptions( $info['options'] ); |
||
| 173 | $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name; |
||
| 174 | $val = []; |
||
| 175 | |||
| 176 | foreach ( $options as $value ) { |
||
| 177 | if ( $user->getOption( "$prefix$value" ) ) { |
||
| 178 | $val[] = $value; |
||
| 179 | } |
||
| 180 | } |
||
| 181 | } |
||
| 182 | |||
| 183 | // Handling for checkmatrix preferences |
||
| 184 | if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) || |
||
| 185 | ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) { |
||
| 186 | $columns = HTMLFormField::flattenOptions( $info['columns'] ); |
||
| 187 | $rows = HTMLFormField::flattenOptions( $info['rows'] ); |
||
| 188 | $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name; |
||
| 189 | $val = []; |
||
| 190 | |||
| 191 | foreach ( $columns as $column ) { |
||
| 192 | foreach ( $rows as $row ) { |
||
| 193 | if ( $user->getOption( "$prefix$column-$row" ) ) { |
||
| 194 | $val[] = "$column-$row"; |
||
| 195 | } |
||
| 196 | } |
||
| 197 | } |
||
| 198 | } |
||
| 199 | |||
| 200 | return $val; |
||
| 201 | } |
||
| 202 | |||
| 203 | /** |
||
| 204 | * @param User $user |
||
| 205 | * @param IContextSource $context |
||
| 206 | * @param array $defaultPreferences |
||
| 207 | * @return void |
||
| 208 | */ |
||
| 209 | static function profilePreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 578 | |||
| 579 | /** |
||
| 580 | * @param User $user |
||
| 581 | * @param IContextSource $context |
||
| 582 | * @param array $defaultPreferences |
||
| 583 | * @return void |
||
| 584 | */ |
||
| 585 | static function skinPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 586 | # # Skin ##################################### |
||
| 587 | |||
| 588 | // Skin selector, if there is at least one valid skin |
||
| 589 | $skinOptions = self::generateSkinOptions( $user, $context ); |
||
| 590 | View Code Duplication | if ( $skinOptions ) { |
|
| 591 | $defaultPreferences['skin'] = [ |
||
| 592 | 'type' => 'radio', |
||
| 593 | 'options' => $skinOptions, |
||
| 594 | 'label' => ' ', |
||
| 595 | 'section' => 'rendering/skin', |
||
| 596 | ]; |
||
| 597 | } |
||
| 598 | |||
| 599 | $config = $context->getConfig(); |
||
| 600 | $allowUserCss = $config->get( 'AllowUserCss' ); |
||
| 601 | $allowUserJs = $config->get( 'AllowUserJs' ); |
||
| 602 | # Create links to user CSS/JS pages for all skins |
||
| 603 | # This code is basically copied from generateSkinOptions(). It'd |
||
| 604 | # be nice to somehow merge this back in there to avoid redundancy. |
||
| 605 | if ( $allowUserCss || $allowUserJs ) { |
||
| 606 | $linkTools = []; |
||
| 607 | $userName = $user->getName(); |
||
| 608 | |||
| 609 | View Code Duplication | if ( $allowUserCss ) { |
|
| 610 | $cssPage = Title::makeTitleSafe( NS_USER, $userName . '/common.css' ); |
||
| 611 | $linkTools[] = Linker::link( $cssPage, $context->msg( 'prefs-custom-css' )->escaped() ); |
||
| 612 | } |
||
| 613 | |||
| 614 | View Code Duplication | if ( $allowUserJs ) { |
|
| 615 | $jsPage = Title::makeTitleSafe( NS_USER, $userName . '/common.js' ); |
||
| 616 | $linkTools[] = Linker::link( $jsPage, $context->msg( 'prefs-custom-js' )->escaped() ); |
||
| 617 | } |
||
| 618 | |||
| 619 | $defaultPreferences['commoncssjs'] = [ |
||
| 620 | 'type' => 'info', |
||
| 621 | 'raw' => true, |
||
| 622 | 'default' => $context->getLanguage()->pipeList( $linkTools ), |
||
| 623 | 'label-message' => 'prefs-common-css-js', |
||
| 624 | 'section' => 'rendering/skin', |
||
| 625 | ]; |
||
| 626 | } |
||
| 627 | } |
||
| 628 | |||
| 629 | /** |
||
| 630 | * @param User $user |
||
| 631 | * @param IContextSource $context |
||
| 632 | * @param array $defaultPreferences |
||
| 633 | */ |
||
| 634 | static function filesPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 635 | # # Files ##################################### |
||
| 636 | $defaultPreferences['imagesize'] = [ |
||
| 637 | 'type' => 'select', |
||
| 638 | 'options' => self::getImageSizes( $context ), |
||
| 639 | 'label-message' => 'imagemaxsize', |
||
| 640 | 'section' => 'rendering/files', |
||
| 641 | ]; |
||
| 642 | $defaultPreferences['thumbsize'] = [ |
||
| 643 | 'type' => 'select', |
||
| 644 | 'options' => self::getThumbSizes( $context ), |
||
| 645 | 'label-message' => 'thumbsize', |
||
| 646 | 'section' => 'rendering/files', |
||
| 647 | ]; |
||
| 648 | } |
||
| 649 | |||
| 650 | /** |
||
| 651 | * @param User $user |
||
| 652 | * @param IContextSource $context |
||
| 653 | * @param array $defaultPreferences |
||
| 654 | * @return void |
||
| 655 | */ |
||
| 656 | static function datetimePreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 657 | # # Date and time ##################################### |
||
| 658 | $dateOptions = self::getDateOptions( $context ); |
||
| 659 | View Code Duplication | if ( $dateOptions ) { |
|
| 660 | $defaultPreferences['date'] = [ |
||
| 661 | 'type' => 'radio', |
||
| 662 | 'options' => $dateOptions, |
||
| 663 | 'label' => ' ', |
||
| 664 | 'section' => 'rendering/dateformat', |
||
| 665 | ]; |
||
| 666 | } |
||
| 667 | |||
| 668 | // Info |
||
| 669 | $now = wfTimestampNow(); |
||
| 670 | $lang = $context->getLanguage(); |
||
| 671 | $nowlocal = Xml::element( 'span', [ 'id' => 'wpLocalTime' ], |
||
| 672 | $lang->userTime( $now, $user ) ); |
||
| 673 | $nowserver = $lang->userTime( $now, $user, |
||
| 674 | [ 'format' => false, 'timecorrection' => false ] ) . |
||
| 675 | Html::hidden( 'wpServerTime', (int)substr( $now, 8, 2 ) * 60 + (int)substr( $now, 10, 2 ) ); |
||
| 676 | |||
| 677 | $defaultPreferences['nowserver'] = [ |
||
| 678 | 'type' => 'info', |
||
| 679 | 'raw' => 1, |
||
| 680 | 'label-message' => 'servertime', |
||
| 681 | 'default' => $nowserver, |
||
| 682 | 'section' => 'rendering/timeoffset', |
||
| 683 | ]; |
||
| 684 | |||
| 685 | $defaultPreferences['nowlocal'] = [ |
||
| 686 | 'type' => 'info', |
||
| 687 | 'raw' => 1, |
||
| 688 | 'label-message' => 'localtime', |
||
| 689 | 'default' => $nowlocal, |
||
| 690 | 'section' => 'rendering/timeoffset', |
||
| 691 | ]; |
||
| 692 | |||
| 693 | // Grab existing pref. |
||
| 694 | $tzOffset = $user->getOption( 'timecorrection' ); |
||
| 695 | $tz = explode( '|', $tzOffset, 3 ); |
||
| 696 | |||
| 697 | $tzOptions = self::getTimezoneOptions( $context ); |
||
| 698 | |||
| 699 | $tzSetting = $tzOffset; |
||
| 700 | if ( count( $tz ) > 1 && $tz[0] == 'Offset' ) { |
||
| 701 | $minDiff = $tz[1]; |
||
| 702 | $tzSetting = sprintf( '%+03d:%02d', floor( $minDiff / 60 ), abs( $minDiff ) % 60 ); |
||
| 703 | } elseif ( count( $tz ) > 1 && $tz[0] == 'ZoneInfo' && |
||
| 704 | !in_array( $tzOffset, HTMLFormField::flattenOptions( $tzOptions ) ) |
||
| 705 | ) { |
||
| 706 | # Timezone offset can vary with DST |
||
| 707 | $userTZ = timezone_open( $tz[2] ); |
||
| 708 | if ( $userTZ !== false ) { |
||
| 709 | $minDiff = floor( timezone_offset_get( $userTZ, date_create( 'now' ) ) / 60 ); |
||
| 710 | $tzSetting = "ZoneInfo|$minDiff|{$tz[2]}"; |
||
| 711 | } |
||
| 712 | } |
||
| 713 | |||
| 714 | $defaultPreferences['timecorrection'] = [ |
||
| 715 | 'class' => 'HTMLSelectOrOtherField', |
||
| 716 | 'label-message' => 'timezonelegend', |
||
| 717 | 'options' => $tzOptions, |
||
| 718 | 'default' => $tzSetting, |
||
| 719 | 'size' => 20, |
||
| 720 | 'section' => 'rendering/timeoffset', |
||
| 721 | ]; |
||
| 722 | } |
||
| 723 | |||
| 724 | /** |
||
| 725 | * @param User $user |
||
| 726 | * @param IContextSource $context |
||
| 727 | * @param array $defaultPreferences |
||
| 728 | */ |
||
| 729 | static function renderingPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 730 | # # Diffs #################################### |
||
| 731 | $defaultPreferences['diffonly'] = [ |
||
| 732 | 'type' => 'toggle', |
||
| 733 | 'section' => 'rendering/diffs', |
||
| 734 | 'label-message' => 'tog-diffonly', |
||
| 735 | ]; |
||
| 736 | $defaultPreferences['norollbackdiff'] = [ |
||
| 737 | 'type' => 'toggle', |
||
| 738 | 'section' => 'rendering/diffs', |
||
| 739 | 'label-message' => 'tog-norollbackdiff', |
||
| 740 | ]; |
||
| 741 | |||
| 742 | # # Page Rendering ############################## |
||
| 743 | if ( $context->getConfig()->get( 'AllowUserCssPrefs' ) ) { |
||
| 744 | $defaultPreferences['underline'] = [ |
||
| 745 | 'type' => 'select', |
||
| 746 | 'options' => [ |
||
| 747 | $context->msg( 'underline-never' )->text() => 0, |
||
| 748 | $context->msg( 'underline-always' )->text() => 1, |
||
| 749 | $context->msg( 'underline-default' )->text() => 2, |
||
| 750 | ], |
||
| 751 | 'label-message' => 'tog-underline', |
||
| 752 | 'section' => 'rendering/advancedrendering', |
||
| 753 | ]; |
||
| 754 | } |
||
| 755 | |||
| 756 | $stubThresholdValues = [ 50, 100, 500, 1000, 2000, 5000, 10000 ]; |
||
| 757 | $stubThresholdOptions = [ $context->msg( 'stub-threshold-disabled' )->text() => 0 ]; |
||
| 758 | foreach ( $stubThresholdValues as $value ) { |
||
| 759 | $stubThresholdOptions[$context->msg( 'size-bytes', $value )->text()] = $value; |
||
| 760 | } |
||
| 761 | |||
| 762 | $defaultPreferences['stubthreshold'] = [ |
||
| 763 | 'type' => 'select', |
||
| 764 | 'section' => 'rendering/advancedrendering', |
||
| 765 | 'options' => $stubThresholdOptions, |
||
| 766 | // This is not a raw HTML message; label-raw is needed for the manual <a></a> |
||
| 767 | 'label-raw' => $context->msg( 'stub-threshold' )->rawParams( |
||
| 768 | '<a href="#" class="stub">' . |
||
| 769 | $context->msg( 'stub-threshold-sample-link' )->parse() . |
||
| 770 | '</a>' )->parse(), |
||
| 771 | ]; |
||
| 772 | |||
| 773 | $defaultPreferences['showhiddencats'] = [ |
||
| 774 | 'type' => 'toggle', |
||
| 775 | 'section' => 'rendering/advancedrendering', |
||
| 776 | 'label-message' => 'tog-showhiddencats' |
||
| 777 | ]; |
||
| 778 | |||
| 779 | $defaultPreferences['numberheadings'] = [ |
||
| 780 | 'type' => 'toggle', |
||
| 781 | 'section' => 'rendering/advancedrendering', |
||
| 782 | 'label-message' => 'tog-numberheadings', |
||
| 783 | ]; |
||
| 784 | } |
||
| 785 | |||
| 786 | /** |
||
| 787 | * @param User $user |
||
| 788 | * @param IContextSource $context |
||
| 789 | * @param array $defaultPreferences |
||
| 790 | */ |
||
| 791 | static function editingPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 792 | # # Editing ##################################### |
||
| 793 | $defaultPreferences['editsectiononrightclick'] = [ |
||
| 794 | 'type' => 'toggle', |
||
| 795 | 'section' => 'editing/advancedediting', |
||
| 796 | 'label-message' => 'tog-editsectiononrightclick', |
||
| 797 | ]; |
||
| 798 | $defaultPreferences['editondblclick'] = [ |
||
| 799 | 'type' => 'toggle', |
||
| 800 | 'section' => 'editing/advancedediting', |
||
| 801 | 'label-message' => 'tog-editondblclick', |
||
| 802 | ]; |
||
| 803 | |||
| 804 | if ( $context->getConfig()->get( 'AllowUserCssPrefs' ) ) { |
||
| 805 | $defaultPreferences['editfont'] = [ |
||
| 806 | 'type' => 'select', |
||
| 807 | 'section' => 'editing/editor', |
||
| 808 | 'label-message' => 'editfont-style', |
||
| 809 | 'options' => [ |
||
| 810 | $context->msg( 'editfont-default' )->text() => 'default', |
||
| 811 | $context->msg( 'editfont-monospace' )->text() => 'monospace', |
||
| 812 | $context->msg( 'editfont-sansserif' )->text() => 'sans-serif', |
||
| 813 | $context->msg( 'editfont-serif' )->text() => 'serif', |
||
| 814 | ] |
||
| 815 | ]; |
||
| 816 | } |
||
| 817 | $defaultPreferences['cols'] = [ |
||
| 818 | 'type' => 'int', |
||
| 819 | 'label-message' => 'columns', |
||
| 820 | 'section' => 'editing/editor', |
||
| 821 | 'min' => 4, |
||
| 822 | 'max' => 1000, |
||
| 823 | ]; |
||
| 824 | $defaultPreferences['rows'] = [ |
||
| 825 | 'type' => 'int', |
||
| 826 | 'label-message' => 'rows', |
||
| 827 | 'section' => 'editing/editor', |
||
| 828 | 'min' => 4, |
||
| 829 | 'max' => 1000, |
||
| 830 | ]; |
||
| 831 | if ( $user->isAllowed( 'minoredit' ) ) { |
||
| 832 | $defaultPreferences['minordefault'] = [ |
||
| 833 | 'type' => 'toggle', |
||
| 834 | 'section' => 'editing/editor', |
||
| 835 | 'label-message' => 'tog-minordefault', |
||
| 836 | ]; |
||
| 837 | } |
||
| 838 | $defaultPreferences['forceeditsummary'] = [ |
||
| 839 | 'type' => 'toggle', |
||
| 840 | 'section' => 'editing/editor', |
||
| 841 | 'label-message' => 'tog-forceeditsummary', |
||
| 842 | ]; |
||
| 843 | $defaultPreferences['useeditwarning'] = [ |
||
| 844 | 'type' => 'toggle', |
||
| 845 | 'section' => 'editing/editor', |
||
| 846 | 'label-message' => 'tog-useeditwarning', |
||
| 847 | ]; |
||
| 848 | $defaultPreferences['showtoolbar'] = [ |
||
| 849 | 'type' => 'toggle', |
||
| 850 | 'section' => 'editing/editor', |
||
| 851 | 'label-message' => 'tog-showtoolbar', |
||
| 852 | ]; |
||
| 853 | |||
| 854 | $defaultPreferences['previewonfirst'] = [ |
||
| 855 | 'type' => 'toggle', |
||
| 856 | 'section' => 'editing/preview', |
||
| 857 | 'label-message' => 'tog-previewonfirst', |
||
| 858 | ]; |
||
| 859 | $defaultPreferences['previewontop'] = [ |
||
| 860 | 'type' => 'toggle', |
||
| 861 | 'section' => 'editing/preview', |
||
| 862 | 'label-message' => 'tog-previewontop', |
||
| 863 | ]; |
||
| 864 | $defaultPreferences['uselivepreview'] = [ |
||
| 865 | 'type' => 'toggle', |
||
| 866 | 'section' => 'editing/preview', |
||
| 867 | 'label-message' => 'tog-uselivepreview', |
||
| 868 | ]; |
||
| 869 | |||
| 870 | } |
||
| 871 | |||
| 872 | /** |
||
| 873 | * @param User $user |
||
| 874 | * @param IContextSource $context |
||
| 875 | * @param array $defaultPreferences |
||
| 876 | */ |
||
| 877 | static function rcPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 878 | $config = $context->getConfig(); |
||
| 879 | $rcMaxAge = $config->get( 'RCMaxAge' ); |
||
| 880 | # # RecentChanges ##################################### |
||
| 881 | $defaultPreferences['rcdays'] = [ |
||
| 882 | 'type' => 'float', |
||
| 883 | 'label-message' => 'recentchangesdays', |
||
| 884 | 'section' => 'rc/displayrc', |
||
| 885 | 'min' => 1, |
||
| 886 | 'max' => ceil( $rcMaxAge / ( 3600 * 24 ) ), |
||
| 887 | 'help' => $context->msg( 'recentchangesdays-max' )->numParams( |
||
| 888 | ceil( $rcMaxAge / ( 3600 * 24 ) ) )->escaped() |
||
| 889 | ]; |
||
| 890 | $defaultPreferences['rclimit'] = [ |
||
| 891 | 'type' => 'int', |
||
| 892 | 'label-message' => 'recentchangescount', |
||
| 893 | 'help-message' => 'prefs-help-recentchangescount', |
||
| 894 | 'section' => 'rc/displayrc', |
||
| 895 | ]; |
||
| 896 | $defaultPreferences['usenewrc'] = [ |
||
| 897 | 'type' => 'toggle', |
||
| 898 | 'label-message' => 'tog-usenewrc', |
||
| 899 | 'section' => 'rc/advancedrc', |
||
| 900 | ]; |
||
| 901 | $defaultPreferences['hideminor'] = [ |
||
| 902 | 'type' => 'toggle', |
||
| 903 | 'label-message' => 'tog-hideminor', |
||
| 904 | 'section' => 'rc/advancedrc', |
||
| 905 | ]; |
||
| 906 | |||
| 907 | if ( $config->get( 'RCWatchCategoryMembership' ) ) { |
||
| 908 | $defaultPreferences['hidecategorization'] = [ |
||
| 909 | 'type' => 'toggle', |
||
| 910 | 'label-message' => 'tog-hidecategorization', |
||
| 911 | 'section' => 'rc/advancedrc', |
||
| 912 | ]; |
||
| 913 | } |
||
| 914 | |||
| 915 | if ( $user->useRCPatrol() ) { |
||
| 916 | $defaultPreferences['hidepatrolled'] = [ |
||
| 917 | 'type' => 'toggle', |
||
| 918 | 'section' => 'rc/advancedrc', |
||
| 919 | 'label-message' => 'tog-hidepatrolled', |
||
| 920 | ]; |
||
| 921 | } |
||
| 922 | |||
| 923 | if ( $user->useNPPatrol() ) { |
||
| 924 | $defaultPreferences['newpageshidepatrolled'] = [ |
||
| 925 | 'type' => 'toggle', |
||
| 926 | 'section' => 'rc/advancedrc', |
||
| 927 | 'label-message' => 'tog-newpageshidepatrolled', |
||
| 928 | ]; |
||
| 929 | } |
||
| 930 | |||
| 931 | if ( $config->get( 'RCShowWatchingUsers' ) ) { |
||
| 932 | $defaultPreferences['shownumberswatching'] = [ |
||
| 933 | 'type' => 'toggle', |
||
| 934 | 'section' => 'rc/advancedrc', |
||
| 935 | 'label-message' => 'tog-shownumberswatching', |
||
| 936 | ]; |
||
| 937 | } |
||
| 938 | } |
||
| 939 | |||
| 940 | /** |
||
| 941 | * @param User $user |
||
| 942 | * @param IContextSource $context |
||
| 943 | * @param array $defaultPreferences |
||
| 944 | */ |
||
| 945 | static function watchlistPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 946 | $config = $context->getConfig(); |
||
| 947 | $watchlistdaysMax = ceil( $config->get( 'RCMaxAge' ) / ( 3600 * 24 ) ); |
||
| 948 | |||
| 949 | # # Watchlist ##################################### |
||
| 950 | if ( $user->isAllowed( 'editmywatchlist' ) ) { |
||
| 951 | $editWatchlistLinks = []; |
||
| 952 | $editWatchlistModes = [ |
||
| 953 | 'edit' => [ 'EditWatchlist', false ], |
||
| 954 | 'raw' => [ 'EditWatchlist', 'raw' ], |
||
| 955 | 'clear' => [ 'EditWatchlist', 'clear' ], |
||
| 956 | ]; |
||
| 957 | View Code Duplication | foreach ( $editWatchlistModes as $editWatchlistMode => $mode ) { |
|
| 958 | // Messages: prefs-editwatchlist-edit, prefs-editwatchlist-raw, prefs-editwatchlist-clear |
||
| 959 | $editWatchlistLinks[] = Linker::linkKnown( |
||
| 960 | SpecialPage::getTitleFor( $mode[0], $mode[1] ), |
||
| 961 | $context->msg( "prefs-editwatchlist-{$editWatchlistMode}" )->parse() |
||
| 962 | ); |
||
| 963 | } |
||
| 964 | |||
| 965 | $defaultPreferences['editwatchlist'] = [ |
||
| 966 | 'type' => 'info', |
||
| 967 | 'raw' => true, |
||
| 968 | 'default' => $context->getLanguage()->pipeList( $editWatchlistLinks ), |
||
| 969 | 'label-message' => 'prefs-editwatchlist-label', |
||
| 970 | 'section' => 'watchlist/editwatchlist', |
||
| 971 | ]; |
||
| 972 | } |
||
| 973 | |||
| 974 | $defaultPreferences['watchlistdays'] = [ |
||
| 975 | 'type' => 'float', |
||
| 976 | 'min' => 0, |
||
| 977 | 'max' => $watchlistdaysMax, |
||
| 978 | 'section' => 'watchlist/displaywatchlist', |
||
| 979 | 'help' => $context->msg( 'prefs-watchlist-days-max' )->numParams( |
||
| 980 | $watchlistdaysMax )->escaped(), |
||
| 981 | 'label-message' => 'prefs-watchlist-days', |
||
| 982 | ]; |
||
| 983 | $defaultPreferences['wllimit'] = [ |
||
| 984 | 'type' => 'int', |
||
| 985 | 'min' => 0, |
||
| 986 | 'max' => 1000, |
||
| 987 | 'label-message' => 'prefs-watchlist-edits', |
||
| 988 | 'help' => $context->msg( 'prefs-watchlist-edits-max' )->escaped(), |
||
| 989 | 'section' => 'watchlist/displaywatchlist', |
||
| 990 | ]; |
||
| 991 | $defaultPreferences['extendwatchlist'] = [ |
||
| 992 | 'type' => 'toggle', |
||
| 993 | 'section' => 'watchlist/advancedwatchlist', |
||
| 994 | 'label-message' => 'tog-extendwatchlist', |
||
| 995 | ]; |
||
| 996 | $defaultPreferences['watchlisthideminor'] = [ |
||
| 997 | 'type' => 'toggle', |
||
| 998 | 'section' => 'watchlist/advancedwatchlist', |
||
| 999 | 'label-message' => 'tog-watchlisthideminor', |
||
| 1000 | ]; |
||
| 1001 | $defaultPreferences['watchlisthidebots'] = [ |
||
| 1002 | 'type' => 'toggle', |
||
| 1003 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1004 | 'label-message' => 'tog-watchlisthidebots', |
||
| 1005 | ]; |
||
| 1006 | $defaultPreferences['watchlisthideown'] = [ |
||
| 1007 | 'type' => 'toggle', |
||
| 1008 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1009 | 'label-message' => 'tog-watchlisthideown', |
||
| 1010 | ]; |
||
| 1011 | $defaultPreferences['watchlisthideanons'] = [ |
||
| 1012 | 'type' => 'toggle', |
||
| 1013 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1014 | 'label-message' => 'tog-watchlisthideanons', |
||
| 1015 | ]; |
||
| 1016 | $defaultPreferences['watchlisthideliu'] = [ |
||
| 1017 | 'type' => 'toggle', |
||
| 1018 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1019 | 'label-message' => 'tog-watchlisthideliu', |
||
| 1020 | ]; |
||
| 1021 | $defaultPreferences['watchlistreloadautomatically'] = [ |
||
| 1022 | 'type' => 'toggle', |
||
| 1023 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1024 | 'label-message' => 'tog-watchlistreloadautomatically', |
||
| 1025 | ]; |
||
| 1026 | |||
| 1027 | if ( $config->get( 'RCWatchCategoryMembership' ) ) { |
||
| 1028 | $defaultPreferences['watchlisthidecategorization'] = [ |
||
| 1029 | 'type' => 'toggle', |
||
| 1030 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1031 | 'label-message' => 'tog-watchlisthidecategorization', |
||
| 1032 | ]; |
||
| 1033 | } |
||
| 1034 | |||
| 1035 | if ( $user->useRCPatrol() ) { |
||
| 1036 | $defaultPreferences['watchlisthidepatrolled'] = [ |
||
| 1037 | 'type' => 'toggle', |
||
| 1038 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1039 | 'label-message' => 'tog-watchlisthidepatrolled', |
||
| 1040 | ]; |
||
| 1041 | } |
||
| 1042 | |||
| 1043 | $watchTypes = [ |
||
| 1044 | 'edit' => 'watchdefault', |
||
| 1045 | 'move' => 'watchmoves', |
||
| 1046 | 'delete' => 'watchdeletion' |
||
| 1047 | ]; |
||
| 1048 | |||
| 1049 | // Kinda hacky |
||
| 1050 | if ( $user->isAllowed( 'createpage' ) || $user->isAllowed( 'createtalk' ) ) { |
||
| 1051 | $watchTypes['read'] = 'watchcreations'; |
||
| 1052 | } |
||
| 1053 | |||
| 1054 | if ( $user->isAllowed( 'rollback' ) ) { |
||
| 1055 | $watchTypes['rollback'] = 'watchrollback'; |
||
| 1056 | } |
||
| 1057 | |||
| 1058 | if ( $user->isAllowed( 'upload' ) ) { |
||
| 1059 | $watchTypes['upload'] = 'watchuploads'; |
||
| 1060 | } |
||
| 1061 | |||
| 1062 | foreach ( $watchTypes as $action => $pref ) { |
||
| 1063 | if ( $user->isAllowed( $action ) ) { |
||
| 1064 | // Messages: |
||
| 1065 | // tog-watchdefault, tog-watchmoves, tog-watchdeletion, tog-watchcreations, tog-watchuploads |
||
| 1066 | // tog-watchrollback |
||
| 1067 | $defaultPreferences[$pref] = [ |
||
| 1068 | 'type' => 'toggle', |
||
| 1069 | 'section' => 'watchlist/advancedwatchlist', |
||
| 1070 | 'label-message' => "tog-$pref", |
||
| 1071 | ]; |
||
| 1072 | } |
||
| 1073 | } |
||
| 1074 | |||
| 1075 | if ( $config->get( 'EnableAPI' ) ) { |
||
| 1076 | $defaultPreferences['watchlisttoken'] = [ |
||
| 1077 | 'type' => 'api', |
||
| 1078 | ]; |
||
| 1079 | $defaultPreferences['watchlisttoken-info'] = [ |
||
| 1080 | 'type' => 'info', |
||
| 1081 | 'section' => 'watchlist/tokenwatchlist', |
||
| 1082 | 'label-message' => 'prefs-watchlist-token', |
||
| 1083 | 'default' => $user->getTokenFromOption( 'watchlisttoken' ), |
||
| 1084 | 'help-message' => 'prefs-help-watchlist-token2', |
||
| 1085 | ]; |
||
| 1086 | } |
||
| 1087 | } |
||
| 1088 | |||
| 1089 | /** |
||
| 1090 | * @param User $user |
||
| 1091 | * @param IContextSource $context |
||
| 1092 | * @param array $defaultPreferences |
||
| 1093 | */ |
||
| 1094 | static function searchPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 1095 | foreach ( MWNamespace::getValidNamespaces() as $n ) { |
||
| 1096 | $defaultPreferences['searchNs' . $n] = [ |
||
| 1097 | 'type' => 'api', |
||
| 1098 | ]; |
||
| 1099 | } |
||
| 1100 | } |
||
| 1101 | |||
| 1102 | /** |
||
| 1103 | * Dummy, kept for backwards-compatibility. |
||
| 1104 | */ |
||
| 1105 | static function miscPreferences( $user, IContextSource $context, &$defaultPreferences ) { |
||
| 1106 | } |
||
| 1107 | |||
| 1108 | /** |
||
| 1109 | * @param User $user The User object |
||
| 1110 | * @param IContextSource $context |
||
| 1111 | * @return array Text/links to display as key; $skinkey as value |
||
| 1112 | */ |
||
| 1113 | static function generateSkinOptions( $user, IContextSource $context ) { |
||
| 1114 | $ret = []; |
||
| 1115 | |||
| 1116 | $mptitle = Title::newMainPage(); |
||
| 1117 | $previewtext = $context->msg( 'skin-preview' )->escaped(); |
||
| 1118 | |||
| 1119 | # Only show skins that aren't disabled in $wgSkipSkins |
||
| 1120 | $validSkinNames = Skin::getAllowedSkins(); |
||
| 1121 | |||
| 1122 | # Sort by UI skin name. First though need to update validSkinNames as sometimes |
||
| 1123 | # the skinkey & UI skinname differ (e.g. "standard" skinkey is "Classic" in the UI). |
||
| 1124 | foreach ( $validSkinNames as $skinkey => &$skinname ) { |
||
| 1125 | $msg = $context->msg( "skinname-{$skinkey}" ); |
||
| 1126 | if ( $msg->exists() ) { |
||
| 1127 | $skinname = htmlspecialchars( $msg->text() ); |
||
| 1128 | } |
||
| 1129 | } |
||
| 1130 | asort( $validSkinNames ); |
||
| 1131 | |||
| 1132 | $config = $context->getConfig(); |
||
| 1133 | $defaultSkin = $config->get( 'DefaultSkin' ); |
||
| 1134 | $allowUserCss = $config->get( 'AllowUserCss' ); |
||
| 1135 | $allowUserJs = $config->get( 'AllowUserJs' ); |
||
| 1136 | |||
| 1137 | $foundDefault = false; |
||
| 1138 | foreach ( $validSkinNames as $skinkey => $sn ) { |
||
| 1139 | $linkTools = []; |
||
| 1140 | |||
| 1141 | # Mark the default skin |
||
| 1142 | if ( strcasecmp( $skinkey, $defaultSkin ) === 0 ) { |
||
| 1143 | $linkTools[] = $context->msg( 'default' )->escaped(); |
||
| 1144 | $foundDefault = true; |
||
| 1145 | } |
||
| 1146 | |||
| 1147 | # Create preview link |
||
| 1148 | $mplink = htmlspecialchars( $mptitle->getLocalURL( [ 'useskin' => $skinkey ] ) ); |
||
| 1149 | $linkTools[] = "<a target='_blank' href=\"$mplink\">$previewtext</a>"; |
||
| 1150 | |||
| 1151 | # Create links to user CSS/JS pages |
||
| 1152 | View Code Duplication | if ( $allowUserCss ) { |
|
| 1153 | $cssPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.css' ); |
||
| 1154 | $linkTools[] = Linker::link( $cssPage, $context->msg( 'prefs-custom-css' )->escaped() ); |
||
| 1155 | } |
||
| 1156 | |||
| 1157 | View Code Duplication | if ( $allowUserJs ) { |
|
| 1158 | $jsPage = Title::makeTitleSafe( NS_USER, $user->getName() . '/' . $skinkey . '.js' ); |
||
| 1159 | $linkTools[] = Linker::link( $jsPage, $context->msg( 'prefs-custom-js' )->escaped() ); |
||
| 1160 | } |
||
| 1161 | |||
| 1162 | $display = $sn . ' ' . $context->msg( 'parentheses' ) |
||
| 1163 | ->rawParams( $context->getLanguage()->pipeList( $linkTools ) ) |
||
| 1164 | ->escaped(); |
||
| 1165 | $ret[$display] = $skinkey; |
||
| 1166 | } |
||
| 1167 | |||
| 1168 | if ( !$foundDefault ) { |
||
| 1169 | // If the default skin is not available, things are going to break horribly because the |
||
| 1170 | // default value for skin selector will not be a valid value. Let's just not show it then. |
||
| 1171 | return []; |
||
| 1172 | } |
||
| 1173 | |||
| 1174 | return $ret; |
||
| 1175 | } |
||
| 1176 | |||
| 1177 | /** |
||
| 1178 | * @param IContextSource $context |
||
| 1179 | * @return array |
||
| 1180 | */ |
||
| 1181 | static function getDateOptions( IContextSource $context ) { |
||
| 1182 | $lang = $context->getLanguage(); |
||
| 1183 | $dateopts = $lang->getDatePreferences(); |
||
| 1184 | |||
| 1185 | $ret = []; |
||
| 1186 | |||
| 1187 | if ( $dateopts ) { |
||
| 1188 | if ( !in_array( 'default', $dateopts ) ) { |
||
| 1189 | $dateopts[] = 'default'; // Make sure default is always valid |
||
| 1190 | // Bug 19237 |
||
| 1191 | } |
||
| 1192 | |||
| 1193 | // FIXME KLUGE: site default might not be valid for user language |
||
| 1194 | global $wgDefaultUserOptions; |
||
| 1195 | if ( !in_array( $wgDefaultUserOptions['date'], $dateopts ) ) { |
||
| 1196 | $wgDefaultUserOptions['date'] = 'default'; |
||
| 1197 | } |
||
| 1198 | |||
| 1199 | $epoch = wfTimestampNow(); |
||
| 1200 | foreach ( $dateopts as $key ) { |
||
| 1201 | if ( $key == 'default' ) { |
||
| 1202 | $formatted = $context->msg( 'datedefault' )->escaped(); |
||
| 1203 | } else { |
||
| 1204 | $formatted = htmlspecialchars( $lang->timeanddate( $epoch, false, $key ) ); |
||
| 1205 | } |
||
| 1206 | $ret[$formatted] = $key; |
||
| 1207 | } |
||
| 1208 | } |
||
| 1209 | return $ret; |
||
| 1210 | } |
||
| 1211 | |||
| 1212 | /** |
||
| 1213 | * @param IContextSource $context |
||
| 1214 | * @return array |
||
| 1215 | */ |
||
| 1216 | static function getImageSizes( IContextSource $context ) { |
||
| 1217 | $ret = []; |
||
| 1218 | $pixels = $context->msg( 'unit-pixel' )->text(); |
||
| 1219 | |||
| 1220 | foreach ( $context->getConfig()->get( 'ImageLimits' ) as $index => $limits ) { |
||
| 1221 | $display = "{$limits[0]}×{$limits[1]}" . $pixels; |
||
| 1222 | $ret[$display] = $index; |
||
| 1223 | } |
||
| 1224 | |||
| 1225 | return $ret; |
||
| 1226 | } |
||
| 1227 | |||
| 1228 | /** |
||
| 1229 | * @param IContextSource $context |
||
| 1230 | * @return array |
||
| 1231 | */ |
||
| 1232 | static function getThumbSizes( IContextSource $context ) { |
||
| 1233 | $ret = []; |
||
| 1234 | $pixels = $context->msg( 'unit-pixel' )->text(); |
||
| 1235 | |||
| 1236 | foreach ( $context->getConfig()->get( 'ThumbLimits' ) as $index => $size ) { |
||
| 1237 | $display = $size . $pixels; |
||
| 1238 | $ret[$display] = $index; |
||
| 1239 | } |
||
| 1240 | |||
| 1241 | return $ret; |
||
| 1242 | } |
||
| 1243 | |||
| 1244 | /** |
||
| 1245 | * @param string $signature |
||
| 1246 | * @param array $alldata |
||
| 1247 | * @param HTMLForm $form |
||
| 1248 | * @return bool|string |
||
| 1249 | */ |
||
| 1250 | static function validateSignature( $signature, $alldata, $form ) { |
||
| 1251 | global $wgParser; |
||
| 1252 | $maxSigChars = $form->getConfig()->get( 'MaxSigChars' ); |
||
| 1253 | if ( mb_strlen( $signature ) > $maxSigChars ) { |
||
| 1254 | return Xml::element( 'span', [ 'class' => 'error' ], |
||
| 1255 | $form->msg( 'badsiglength' )->numParams( $maxSigChars )->text() ); |
||
| 1256 | } elseif ( isset( $alldata['fancysig'] ) && |
||
| 1257 | $alldata['fancysig'] && |
||
| 1258 | $wgParser->validateSig( $signature ) === false |
||
| 1259 | ) { |
||
| 1260 | return Xml::element( |
||
| 1261 | 'span', |
||
| 1262 | [ 'class' => 'error' ], |
||
| 1263 | $form->msg( 'badsig' )->text() |
||
| 1264 | ); |
||
| 1265 | } else { |
||
| 1266 | return true; |
||
| 1267 | } |
||
| 1268 | } |
||
| 1269 | |||
| 1270 | /** |
||
| 1271 | * @param string $signature |
||
| 1272 | * @param array $alldata |
||
| 1273 | * @param HTMLForm $form |
||
| 1274 | * @return string |
||
| 1275 | */ |
||
| 1276 | static function cleanSignature( $signature, $alldata, $form ) { |
||
| 1277 | if ( isset( $alldata['fancysig'] ) && $alldata['fancysig'] ) { |
||
| 1278 | global $wgParser; |
||
| 1279 | $signature = $wgParser->cleanSig( $signature ); |
||
| 1280 | } else { |
||
| 1281 | // When no fancy sig used, make sure ~{3,5} get removed. |
||
| 1282 | $signature = Parser::cleanSigInSig( $signature ); |
||
| 1283 | } |
||
| 1284 | |||
| 1285 | return $signature; |
||
| 1286 | } |
||
| 1287 | |||
| 1288 | /** |
||
| 1289 | * @param User $user |
||
| 1290 | * @param IContextSource $context |
||
| 1291 | * @param string $formClass |
||
| 1292 | * @param array $remove Array of items to remove |
||
| 1293 | * @return PreferencesForm|HtmlForm |
||
| 1294 | */ |
||
| 1295 | static function getFormObject( |
||
| 1296 | $user, |
||
| 1297 | IContextSource $context, |
||
| 1298 | $formClass = 'PreferencesForm', |
||
| 1299 | array $remove = [] |
||
| 1300 | ) { |
||
| 1301 | $formDescriptor = Preferences::getPreferences( $user, $context ); |
||
| 1302 | if ( count( $remove ) ) { |
||
| 1303 | $removeKeys = array_flip( $remove ); |
||
| 1304 | $formDescriptor = array_diff_key( $formDescriptor, $removeKeys ); |
||
| 1305 | } |
||
| 1306 | |||
| 1307 | // Remove type=api preferences. They are not intended for rendering in the form. |
||
| 1308 | foreach ( $formDescriptor as $name => $info ) { |
||
| 1309 | if ( isset( $info['type'] ) && $info['type'] === 'api' ) { |
||
| 1310 | unset( $formDescriptor[$name] ); |
||
| 1311 | } |
||
| 1312 | } |
||
| 1313 | |||
| 1314 | /** |
||
| 1315 | * @var $htmlForm PreferencesForm |
||
| 1316 | */ |
||
| 1317 | $htmlForm = new $formClass( $formDescriptor, $context, 'prefs' ); |
||
| 1318 | |||
| 1319 | $htmlForm->setModifiedUser( $user ); |
||
| 1320 | $htmlForm->setId( 'mw-prefs-form' ); |
||
| 1321 | $htmlForm->setAutocomplete( 'off' ); |
||
| 1322 | $htmlForm->setSubmitText( $context->msg( 'saveprefs' )->text() ); |
||
| 1323 | # Used message keys: 'accesskey-preferences-save', 'tooltip-preferences-save' |
||
| 1324 | $htmlForm->setSubmitTooltip( 'preferences-save' ); |
||
| 1325 | $htmlForm->setSubmitID( 'prefsubmit' ); |
||
| 1326 | $htmlForm->setSubmitCallback( [ 'Preferences', 'tryFormSubmit' ] ); |
||
| 1327 | |||
| 1328 | return $htmlForm; |
||
| 1329 | } |
||
| 1330 | |||
| 1331 | /** |
||
| 1332 | * @param IContextSource $context |
||
| 1333 | * @return array |
||
| 1334 | */ |
||
| 1335 | static function getTimezoneOptions( IContextSource $context ) { |
||
| 1336 | $opt = []; |
||
| 1337 | |||
| 1338 | $localTZoffset = $context->getConfig()->get( 'LocalTZoffset' ); |
||
| 1339 | $timeZoneList = self::getTimeZoneList( $context->getLanguage() ); |
||
| 1340 | |||
| 1341 | $timestamp = MWTimestamp::getLocalInstance(); |
||
| 1342 | // Check that the LocalTZoffset is the same as the local time zone offset |
||
| 1343 | if ( $localTZoffset == $timestamp->format( 'Z' ) / 60 ) { |
||
| 1344 | $timezoneName = $timestamp->getTimezone()->getName(); |
||
| 1345 | // Localize timezone |
||
| 1346 | if ( isset( $timeZoneList[$timezoneName] ) ) { |
||
| 1347 | $timezoneName = $timeZoneList[$timezoneName]['name']; |
||
| 1348 | } |
||
| 1349 | $server_tz_msg = $context->msg( |
||
| 1350 | 'timezoneuseserverdefault', |
||
| 1351 | $timezoneName |
||
| 1352 | )->text(); |
||
| 1353 | } else { |
||
| 1354 | $tzstring = sprintf( |
||
| 1355 | '%+03d:%02d', |
||
| 1356 | floor( $localTZoffset / 60 ), |
||
| 1357 | abs( $localTZoffset ) % 60 |
||
| 1358 | ); |
||
| 1359 | $server_tz_msg = $context->msg( 'timezoneuseserverdefault', $tzstring )->text(); |
||
| 1360 | } |
||
| 1361 | $opt[$server_tz_msg] = "System|$localTZoffset"; |
||
| 1362 | $opt[$context->msg( 'timezoneuseoffset' )->text()] = 'other'; |
||
| 1363 | $opt[$context->msg( 'guesstimezone' )->text()] = 'guess'; |
||
| 1364 | |||
| 1365 | foreach ( $timeZoneList as $timeZoneInfo ) { |
||
| 1366 | $region = $timeZoneInfo['region']; |
||
| 1367 | if ( !isset( $opt[$region] ) ) { |
||
| 1368 | $opt[$region] = []; |
||
| 1369 | } |
||
| 1370 | $opt[$region][$timeZoneInfo['name']] = $timeZoneInfo['timecorrection']; |
||
| 1371 | } |
||
| 1372 | return $opt; |
||
| 1373 | } |
||
| 1374 | |||
| 1375 | /** |
||
| 1376 | * @param string $value |
||
| 1377 | * @param array $alldata |
||
| 1378 | * @return int |
||
| 1379 | */ |
||
| 1380 | static function filterIntval( $value, $alldata ) { |
||
| 1381 | return intval( $value ); |
||
| 1382 | } |
||
| 1383 | |||
| 1384 | /** |
||
| 1385 | * @param string $tz |
||
| 1386 | * @param array $alldata |
||
| 1387 | * @return string |
||
| 1388 | */ |
||
| 1389 | static function filterTimezoneInput( $tz, $alldata ) { |
||
| 1390 | $data = explode( '|', $tz, 3 ); |
||
| 1391 | switch ( $data[0] ) { |
||
| 1392 | case 'ZoneInfo': |
||
| 1393 | case 'System': |
||
| 1394 | return $tz; |
||
| 1395 | default: |
||
| 1396 | $data = explode( ':', $tz, 2 ); |
||
| 1397 | View Code Duplication | if ( count( $data ) == 2 ) { |
|
| 1398 | $data[0] = intval( $data[0] ); |
||
| 1399 | $data[1] = intval( $data[1] ); |
||
| 1400 | $minDiff = abs( $data[0] ) * 60 + $data[1]; |
||
| 1401 | if ( $data[0] < 0 ) { |
||
| 1402 | $minDiff = - $minDiff; |
||
| 1403 | } |
||
| 1404 | } else { |
||
| 1405 | $minDiff = intval( $data[0] ) * 60; |
||
| 1406 | } |
||
| 1407 | |||
| 1408 | # Max is +14:00 and min is -12:00, see: |
||
| 1409 | # https://en.wikipedia.org/wiki/Timezone |
||
| 1410 | $minDiff = min( $minDiff, 840 ); # 14:00 |
||
| 1411 | $minDiff = max( $minDiff, - 720 ); # -12:00 |
||
| 1412 | return 'Offset|' . $minDiff; |
||
| 1413 | } |
||
| 1414 | } |
||
| 1415 | |||
| 1416 | /** |
||
| 1417 | * Handle the form submission if everything validated properly |
||
| 1418 | * |
||
| 1419 | * @param array $formData |
||
| 1420 | * @param PreferencesForm $form |
||
| 1421 | * @return bool|Status|string |
||
| 1422 | */ |
||
| 1423 | static function tryFormSubmit( $formData, $form ) { |
||
| 1480 | |||
| 1481 | /** |
||
| 1482 | * @param array $formData |
||
| 1483 | * @param PreferencesForm $form |
||
| 1484 | * @return Status |
||
| 1485 | */ |
||
| 1486 | public static function tryUISubmit( $formData, $form ) { |
||
| 1487 | $res = self::tryFormSubmit( $formData, $form ); |
||
| 1488 | |||
| 1489 | if ( $res ) { |
||
| 1490 | $urlOptions = []; |
||
| 1491 | |||
| 1492 | if ( $res === 'eauth' ) { |
||
| 1493 | $urlOptions['eauth'] = 1; |
||
| 1494 | } |
||
| 1495 | |||
| 1496 | $urlOptions += $form->getExtraSuccessRedirectParameters(); |
||
| 1497 | |||
| 1498 | $url = $form->getTitle()->getFullURL( $urlOptions ); |
||
| 1499 | |||
| 1500 | $context = $form->getContext(); |
||
| 1501 | // Set session data for the success message |
||
| 1502 | $context->getRequest()->setSessionData( 'specialPreferencesSaveSuccess', 1 ); |
||
| 1503 | |||
| 1509 | |||
| 1510 | /** |
||
| 1511 | * Get a list of all time zones |
||
| 1512 | * @param Language $language Language used for the localized names |
||
| 1513 | * @return array A list of all time zones. The system name of the time zone is used as key and |
||
| 1514 | * the value is an array which contains localized name, the timecorrection value used for |
||
| 1515 | * preferences and the region |
||
| 1516 | * @since 1.26 |
||
| 1517 | */ |
||
| 1518 | public static function getTimeZoneList( Language $language ) { |
||
| 1571 | } |
||
| 1572 | |||
| 1692 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: