WordPress 4.7
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-theme-install-list-table.php
1 <?php
2 /**
3  * List Table API: WP_Theme_Install_List_Table class
4  *
5  * @package WordPress
6  * @subpackage Administration
7  * @since 3.1.0
8  */
9
10 /**
11  * Core class used to implement displaying themes to install in a list table.
12  *
13  * @since 3.1.0
14  * @access private
15  *
16  * @see WP_Themes_List_Table
17  */
18 class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
19
20         public $features = array();
21
22         /**
23          *
24          * @return bool
25          */
26         public function ajax_user_can() {
27                 return current_user_can( 'install_themes' );
28         }
29
30         /**
31          *
32          * @global array  $tabs
33          * @global string $tab
34          * @global int    $paged
35          * @global string $type
36          * @global array  $theme_field_defaults
37          */
38         public function prepare_items() {
39                 include( ABSPATH . 'wp-admin/includes/theme-install.php' );
40
41                 global $tabs, $tab, $paged, $type, $theme_field_defaults;
42                 wp_reset_vars( array( 'tab' ) );
43
44                 $search_terms = array();
45                 $search_string = '';
46                 if ( ! empty( $_REQUEST['s'] ) ){
47                         $search_string = strtolower( wp_unslash( $_REQUEST['s'] ) );
48                         $search_terms = array_unique( array_filter( array_map( 'trim', explode( ',', $search_string ) ) ) );
49                 }
50
51                 if ( ! empty( $_REQUEST['features'] ) )
52                         $this->features = $_REQUEST['features'];
53
54                 $paged = $this->get_pagenum();
55
56                 $per_page = 36;
57
58                 // These are the tabs which are shown on the page,
59                 $tabs = array();
60                 $tabs['dashboard'] = __( 'Search' );
61                 if ( 'search' === $tab )
62                         $tabs['search'] = __( 'Search Results' );
63                 $tabs['upload'] = __( 'Upload' );
64                 $tabs['featured'] = _x( 'Featured', 'themes' );
65                 //$tabs['popular']  = _x( 'Popular', 'themes' );
66                 $tabs['new']      = _x( 'Latest', 'themes' );
67                 $tabs['updated']  = _x( 'Recently Updated', 'themes' );
68
69                 $nonmenu_tabs = array( 'theme-information' ); // Valid actions to perform which do not have a Menu item.
70
71                 /** This filter is documented in wp-admin/theme-install.php */
72                 $tabs = apply_filters( 'install_themes_tabs', $tabs );
73
74                 /**
75                  * Filters tabs not associated with a menu item on the Install Themes screen.
76                  *
77                  * @since 2.8.0
78                  *
79                  * @param array $nonmenu_tabs The tabs that don't have a menu item on
80                  *                            the Install Themes screen.
81                  */
82                 $nonmenu_tabs = apply_filters( 'install_themes_nonmenu_tabs', $nonmenu_tabs );
83
84                 // If a non-valid menu tab has been selected, And it's not a non-menu action.
85                 if ( empty( $tab ) || ( ! isset( $tabs[ $tab ] ) && ! in_array( $tab, (array) $nonmenu_tabs ) ) )
86                         $tab = key( $tabs );
87
88                 $args = array( 'page' => $paged, 'per_page' => $per_page, 'fields' => $theme_field_defaults );
89
90                 switch ( $tab ) {
91                         case 'search':
92                                 $type = isset( $_REQUEST['type'] ) ? wp_unslash( $_REQUEST['type'] ) : 'term';
93                                 switch ( $type ) {
94                                         case 'tag':
95                                                 $args['tag'] = array_map( 'sanitize_key', $search_terms );
96                                                 break;
97                                         case 'term':
98                                                 $args['search'] = $search_string;
99                                                 break;
100                                         case 'author':
101                                                 $args['author'] = $search_string;
102                                                 break;
103                                 }
104
105                                 if ( ! empty( $this->features ) ) {
106                                         $args['tag'] = $this->features;
107                                         $_REQUEST['s'] = implode( ',', $this->features );
108                                         $_REQUEST['type'] = 'tag';
109                                 }
110
111                                 add_action( 'install_themes_table_header', 'install_theme_search_form', 10, 0 );
112                                 break;
113
114                         case 'featured':
115                         // case 'popular':
116                         case 'new':
117                         case 'updated':
118                                 $args['browse'] = $tab;
119                                 break;
120
121                         default:
122                                 $args = false;
123                                 break;
124                 }
125
126                 /**
127                  * Filters API request arguments for each Install Themes screen tab.
128                  *
129                  * The dynamic portion of the hook name, `$tab`, refers to the theme install
130                  * tabs. Default tabs are 'dashboard', 'search', 'upload', 'featured',
131                  * 'new', and 'updated'.
132                  *
133                  * @since 3.7.0
134                  *
135                  * @param array $args An array of themes API arguments.
136                  */
137                 $args = apply_filters( "install_themes_table_api_args_{$tab}", $args );
138
139                 if ( ! $args )
140                         return;
141
142                 $api = themes_api( 'query_themes', $args );
143
144                 if ( is_wp_error( $api ) )
145                         wp_die( $api->get_error_message() . '</p> <p><a href="#" onclick="document.location.reload(); return false;">' . __( 'Try again' ) . '</a>' );
146
147                 $this->items = $api->themes;
148
149                 $this->set_pagination_args( array(
150                         'total_items' => $api->info['results'],
151                         'per_page' => $args['per_page'],
152                         'infinite_scroll' => true,
153                 ) );
154         }
155
156         /**
157          * @access public
158          */
159         public function no_items() {
160                 _e( 'No themes match your request.' );
161         }
162
163         /**
164          *
165          * @global array $tabs
166          * @global string $tab
167          * @return array
168          */
169         protected function get_views() {
170                 global $tabs, $tab;
171
172                 $display_tabs = array();
173                 foreach ( (array) $tabs as $action => $text ) {
174                         $class = ( $action === $tab ) ? ' class="current"' : '';
175                         $href = self_admin_url('theme-install.php?tab=' . $action);
176                         $display_tabs['theme-install-'.$action] = "<a href='$href'$class>$text</a>";
177                 }
178
179                 return $display_tabs;
180         }
181
182         /**
183          * @access public
184          */
185         public function display() {
186                 wp_nonce_field( "fetch-list-" . get_class( $this ), '_ajax_fetch_list_nonce' );
187 ?>
188                 <div class="tablenav top themes">
189                         <div class="alignleft actions">
190                                 <?php
191                                 /**
192                                  * Fires in the Install Themes list table header.
193                                  *
194                                  * @since 2.8.0
195                                  */
196                                 do_action( 'install_themes_table_header' );
197                                 ?>
198                         </div>
199                         <?php $this->pagination( 'top' ); ?>
200                         <br class="clear" />
201                 </div>
202
203                 <div id="availablethemes">
204                         <?php $this->display_rows_or_placeholder(); ?>
205                 </div>
206
207                 <?php
208                 $this->tablenav( 'bottom' );
209         }
210
211         /**
212          * @access public
213          */
214         public function display_rows() {
215                 $themes = $this->items;
216                 foreach ( $themes as $theme ) {
217                                 ?>
218                                 <div class="available-theme installable-theme"><?php
219                                         $this->single_row( $theme );
220                                 ?></div>
221                 <?php } // end foreach $theme_names
222
223                 $this->theme_installer();
224         }
225
226         /**
227          * Prints a theme from the WordPress.org API.
228          *
229          * @since 3.1.0
230          * @access public
231          *
232          * @global array $themes_allowedtags
233          *
234          * @param object $theme {
235          *     An object that contains theme data returned by the WordPress.org API.
236          *
237          *     @type string $name           Theme name, e.g. 'Twenty Seventeen'.
238          *     @type string $slug           Theme slug, e.g. 'twentyseventeen'.
239          *     @type string $version        Theme version, e.g. '1.1'.
240          *     @type string $author         Theme author username, e.g. 'melchoyce'.
241          *     @type string $preview_url    Preview URL, e.g. 'http://2017.wordpress.net/'.
242          *     @type string $screenshot_url Screenshot URL, e.g. 'https://wordpress.org/themes/twentyseventeen/'.
243          *     @type float  $rating         Rating score.
244          *     @type int    $num_ratings    The number of ratings.
245          *     @type string $homepage       Theme homepage, e.g. 'https://wordpress.org/themes/twentyseventeen/'.
246          *     @type string $description    Theme description.
247          *     @type string $download_link  Theme ZIP download URL.
248          * }
249          */
250         public function single_row( $theme ) {
251                 global $themes_allowedtags;
252
253                 if ( empty( $theme ) )
254                         return;
255
256                 $name   = wp_kses( $theme->name,   $themes_allowedtags );
257                 $author = wp_kses( $theme->author, $themes_allowedtags );
258
259                 $preview_title = sprintf( __('Preview &#8220;%s&#8221;'), $name );
260                 $preview_url   = add_query_arg( array(
261                         'tab'   => 'theme-information',
262                         'theme' => $theme->slug,
263                 ), self_admin_url( 'theme-install.php' ) );
264
265                 $actions = array();
266
267                 $install_url = add_query_arg( array(
268                         'action' => 'install-theme',
269                         'theme'  => $theme->slug,
270                 ), self_admin_url( 'update.php' ) );
271
272                 $update_url = add_query_arg( array(
273                         'action' => 'upgrade-theme',
274                         'theme'  => $theme->slug,
275                 ), self_admin_url( 'update.php' ) );
276
277                 $status = $this->_get_theme_status( $theme );
278
279                 switch ( $status ) {
280                         case 'update_available':
281                                 $actions[] = '<a class="install-now" href="' . esc_url( wp_nonce_url( $update_url, 'upgrade-theme_' . $theme->slug ) ) . '" title="' . esc_attr( sprintf( __( 'Update to version %s' ), $theme->version ) ) . '">' . __( 'Update' ) . '</a>';
282                                 break;
283                         case 'newer_installed':
284                         case 'latest_installed':
285                                 $actions[] = '<span class="install-now" title="' . esc_attr__( 'This theme is already installed and is up to date' ) . '">' . _x( 'Installed', 'theme' ) . '</span>';
286                                 break;
287                         case 'install':
288                         default:
289                                 $actions[] = '<a class="install-now" href="' . esc_url( wp_nonce_url( $install_url, 'install-theme_' . $theme->slug ) ) . '" title="' . esc_attr( sprintf( __( 'Install %s' ), $name ) ) . '">' . __( 'Install Now' ) . '</a>';
290                                 break;
291                 }
292
293                 $actions[] = '<a class="install-theme-preview" href="' . esc_url( $preview_url ) . '" title="' . esc_attr( sprintf( __( 'Preview %s' ), $name ) ) . '">' . __( 'Preview' ) . '</a>';
294
295                 /**
296                  * Filters the install action links for a theme in the Install Themes list table.
297                  *
298                  * @since 3.4.0
299                  *
300                  * @param array    $actions An array of theme action hyperlinks. Defaults are
301                  *                          links to Install Now, Preview, and Details.
302                  * @param WP_Theme $theme   Theme object.
303                  */
304                 $actions = apply_filters( 'theme_install_actions', $actions, $theme );
305
306                 ?>
307                 <a class="screenshot install-theme-preview" href="<?php echo esc_url( $preview_url ); ?>" title="<?php echo esc_attr( $preview_title ); ?>">
308                         <img src="<?php echo esc_url( $theme->screenshot_url ); ?>" width="150" alt="" />
309                 </a>
310
311                 <h3><?php echo $name; ?></h3>
312                 <div class="theme-author"><?php printf( __( 'By %s' ), $author ); ?></div>
313
314                 <div class="action-links">
315                         <ul>
316                                 <?php foreach ( $actions as $action ): ?>
317                                         <li><?php echo $action; ?></li>
318                                 <?php endforeach; ?>
319                                 <li class="hide-if-no-js"><a href="#" class="theme-detail"><?php _e('Details') ?></a></li>
320                         </ul>
321                 </div>
322
323                 <?php
324                 $this->install_theme_info( $theme );
325         }
326
327         /**
328          * Prints the wrapper for the theme installer.
329          */
330         public function theme_installer() {
331                 ?>
332                 <div id="theme-installer" class="wp-full-overlay expanded">
333                         <div class="wp-full-overlay-sidebar">
334                                 <div class="wp-full-overlay-header">
335                                         <a href="#" class="close-full-overlay button"><?php _e( 'Close' ); ?></a>
336                                         <span class="theme-install"></span>
337                                 </div>
338                                 <div class="wp-full-overlay-sidebar-content">
339                                         <div class="install-theme-info"></div>
340                                 </div>
341                                 <div class="wp-full-overlay-footer">
342                                         <button type="button" class="collapse-sidebar button" aria-expanded="true" aria-label="<?php esc_attr_e( 'Collapse Sidebar' ); ?>">
343                                                 <span class="collapse-sidebar-arrow"></span>
344                                                 <span class="collapse-sidebar-label"><?php _e( 'Collapse' ); ?></span>
345                                         </button>
346                                 </div>
347                         </div>
348                         <div class="wp-full-overlay-main"></div>
349                 </div>
350                 <?php
351         }
352
353         /**
354          * Prints the wrapper for the theme installer with a provided theme's data.
355          * Used to make the theme installer work for no-js.
356          *
357          * @param object $theme - A WordPress.org Theme API object.
358          */
359         public function theme_installer_single( $theme ) {
360                 ?>
361                 <div id="theme-installer" class="wp-full-overlay single-theme">
362                         <div class="wp-full-overlay-sidebar">
363                                 <?php $this->install_theme_info( $theme ); ?>
364                         </div>
365                         <div class="wp-full-overlay-main">
366                                 <iframe src="<?php echo esc_url( $theme->preview_url ); ?>"></iframe>
367                         </div>
368                 </div>
369                 <?php
370         }
371
372         /**
373          * Prints the info for a theme (to be used in the theme installer modal).
374          *
375          * @global array $themes_allowedtags
376          *
377          * @param object $theme - A WordPress.org Theme API object.
378          */
379         public function install_theme_info( $theme ) {
380                 global $themes_allowedtags;
381
382                 if ( empty( $theme ) )
383                         return;
384
385                 $name   = wp_kses( $theme->name,   $themes_allowedtags );
386                 $author = wp_kses( $theme->author, $themes_allowedtags );
387
388                 $install_url = add_query_arg( array(
389                         'action' => 'install-theme',
390                         'theme'  => $theme->slug,
391                 ), self_admin_url( 'update.php' ) );
392
393                 $update_url = add_query_arg( array(
394                         'action' => 'upgrade-theme',
395                         'theme'  => $theme->slug,
396                 ), self_admin_url( 'update.php' ) );
397
398                 $status = $this->_get_theme_status( $theme );
399
400                 ?>
401                 <div class="install-theme-info"><?php
402                         switch ( $status ) {
403                                 case 'update_available':
404                                         echo '<a class="theme-install button button-primary" href="' . esc_url( wp_nonce_url( $update_url, 'upgrade-theme_' . $theme->slug ) ) . '" title="' . esc_attr( sprintf( __( 'Update to version %s' ), $theme->version ) ) . '">' . __( 'Update' ) . '</a>';
405                                         break;
406                                 case 'newer_installed':
407                                 case 'latest_installed':
408                                         echo '<span class="theme-install" title="' . esc_attr__( 'This theme is already installed and is up to date' ) . '">' . _x( 'Installed', 'theme' ) . '</span>';
409                                         break;
410                                 case 'install':
411                                 default:
412                                         echo '<a class="theme-install button button-primary" href="' . esc_url( wp_nonce_url( $install_url, 'install-theme_' . $theme->slug ) ) . '">' . __( 'Install' ) . '</a>';
413                                         break;
414                         } ?>
415                         <h3 class="theme-name"><?php echo $name; ?></h3>
416                         <span class="theme-by"><?php printf( __( 'By %s' ), $author ); ?></span>
417                         <?php if ( isset( $theme->screenshot_url ) ): ?>
418                                 <img class="theme-screenshot" src="<?php echo esc_url( $theme->screenshot_url ); ?>" alt="" />
419                         <?php endif; ?>
420                         <div class="theme-details">
421                                 <?php wp_star_rating( array( 'rating' => $theme->rating, 'type' => 'percent', 'number' => $theme->num_ratings ) ); ?>
422                                 <div class="theme-version">
423                                         <strong><?php _e('Version:') ?> </strong>
424                                         <?php echo wp_kses( $theme->version, $themes_allowedtags ); ?>
425                                 </div>
426                                 <div class="theme-description">
427                                         <?php echo wp_kses( $theme->description, $themes_allowedtags ); ?>
428                                 </div>
429                         </div>
430                         <input class="theme-preview-url" type="hidden" value="<?php echo esc_url( $theme->preview_url ); ?>" />
431                 </div>
432                 <?php
433         }
434
435         /**
436          * Send required variables to JavaScript land
437          *
438          * @since 3.4.0
439          * @access public
440          *
441          * @global string $tab  Current tab within Themes->Install screen
442          * @global string $type Type of search.
443          *
444          * @param array $extra_args Unused.
445          */
446         public function _js_vars( $extra_args = array() ) {
447                 global $tab, $type;
448                 parent::_js_vars( compact( 'tab', 'type' ) );
449         }
450
451         /**
452          * Check to see if the theme is already installed.
453          *
454          * @since 3.4.0
455          * @access private
456          *
457          * @param object $theme - A WordPress.org Theme API object.
458          * @return string Theme status.
459          */
460         private function _get_theme_status( $theme ) {
461                 $status = 'install';
462
463                 $installed_theme = wp_get_theme( $theme->slug );
464                 if ( $installed_theme->exists() ) {
465                         if ( version_compare( $installed_theme->get('Version'), $theme->version, '=' ) )
466                                 $status = 'latest_installed';
467                         elseif ( version_compare( $installed_theme->get('Version'), $theme->version, '>' ) )
468                                 $status = 'newer_installed';
469                         else
470                                 $status = 'update_available';
471                 }
472
473                 return $status;
474         }
475 }