Debug:',esc_html( json_encode(compact('domain','mofile'),JSON_UNESCAPED_SLASHES)),'';
$this->buffered = true;
$this->buffer[$domain][] = $mofile;
}
/**
* Get primary Text Domain that's uniquely assigned to a bundle
* @param string theme or plugin relative path
*/
public function getDomain( $handle ){
$this->flush();
return isset($this->domains[$handle]) ? $this->domains[$handle] : '';
}
/**
* Get the default directory path where captured files of a given domain are held
* @param string TextDomain
* @return string relative path
*/
public function getDomainPath( $domain ){
$this->flush();
return isset($this->domainPaths[$domain]) ? $this->domainPaths[$domain] : '';
}
/**
* Utility: checks if a file path is under a given root
* @return string subpath relative to given root
*/
private static function relative( $path, $root ){
$root = trailingslashit($root);
$snip = strlen($root);
// attempt unaltered path
if( substr($path,0,$snip) === $root ){
return substr( $path, $snip );
}
// attempt resolved in case symlinks along path
$real = realpath($path);
if( $real && $real !== $path && substr($real,0,$snip) === $root ){
return substr( $real, $snip );
}
// path not under root
return null;
}
/**
* Check if given relative directory path the root of a known plugin
* @param string relative plugin directory name, e.g. "foo/bar"
* @return string relative plugin file handle, e.g. "foo/bar/baz.php"
*/
private function isPlugin( $check ){
if( ! $this->pluginHandles ){
$this->pluginHandles = array();
foreach( Loco_package_Plugin::get_plugins() as $handle => $data ){
$this->pluginHandles[ dirname($handle) ] = $handle;
// set default text domain because additional domains could be discovered before the canonical one
if( isset($data['TextDomain']) && ( $domain = $data['TextDomain'] ) ){
$this->domains[$handle] = $domain;
}
}
}
if( ! array_key_exists($check, $this->pluginHandles) ){
return null;
}
return $this->pluginHandles[$check];
}
/**
* Convert a file path to a theme or plugin bundle
* @return Loco_package_Bundle
*/
private function resolve( $path, $domain ){
$file = new Loco_fs_LocaleFile( $path );
// ignore suffix-only files when locale is invalid as locale code would be taken wrongly as slug, e.g. if you tried to load "english.po"
if( $file->hasPrefixOnly() ){
return;
}
// no point looking at files in global directory as they tell us only the domain which we already know
foreach( $this->globalPaths as $prefix => $length ){
if( substr($path,0,$length) === $prefix ){
return;
}
}
// avoid infinite loops during bundle resolution
$wasBuffered = $this->buffered;
$this->buffered = false;
// file prefix is *probably* the Text Domain, but can differ if load_textdomain called directly from bundle code
$slug = $file->getPrefix() or $slug = $domain;
$path = dirname($path);
$bundle = null;
while( true ){
// check if MO file lives inside a theme
foreach( $GLOBALS['wp_theme_directories'] as $root ){
$relative = self::relative($path, $root);
if( is_null($relative) ){
continue;
}
// theme's "stylesheet directory" must be immediately under this root
// passed path could root of theme, or any directory below it, but we only need the top level
$chunks = explode( '/', $relative, 2 );
$handle = current( $chunks );
if( ! $handle ){
continue;
}
$theme = new WP_Theme( $handle, $root );
if( ! $theme->exists() ){
continue;
}
$abspath = $root.'/'.$handle;
// theme may have officially declared text domain
if( $default = $theme->get('TextDomain') ){
$this->domains[$handle] = $default;
}
// else set current domain as default if not already set
else if ( ! isset($this->domains[$handle]) ){
$this->domains[$handle] = $domain;
}
if( ! isset($this->domainPaths[$domain]) ){
$this->domainPaths[$domain] = self::relative( $path, $abspath );
}
// theme bundle may already exist
if( isset($this->themes[$handle]) ){
$bundle = $this->themes[$handle];
}
// create default project for theme bundle
else {
$bundle = Loco_package_Theme::createFromTheme($theme);
$this->themes[$handle] = $bundle;
}
// possibility that additional text domains are being added
$project = $bundle->getProject($slug);
if( ! $project ){
$project = new Loco_package_Project( $bundle, new Loco_package_TextDomain($domain), $slug );
$bundle->addProject( $project );
}
// bundle was a theme, even if we couldn't configure it, so no point checking plugins
break 2;
}
// check if MO file lives inside a plugin
foreach( array( 'WP_PLUGIN_DIR', 'WPMU_PLUGIN_DIR' ) as $const ){
$root = loco_constant( $const );
$relative = self::relative($path, $root);
if( is_null($relative) ){
continue;
}
// plugin *might* live directly under root
$stack = array();
foreach( explode( '/', dirname($relative) ) as $next ){
$stack[] = $next;
$relbase = implode('/', $stack );
if( $handle = $this->isPlugin($relbase) ){
$abspath = $root.'/'.$handle;
// set this as default domain if not already cached
if( ! isset($this->domains[$handle]) ){
$this->domains[$handle] = $domain;
}
if( ! isset($this->domainPaths[$domain]) ){
$target = self::relative( $path, dirname($abspath) );
$this->domainPaths[$domain] = $target;
}
// plugin bundle may already exist
if( isset($this->plugins[$handle]) ){
$bundle = $this->plugins[$handle];
}
// create default project for plugin bundle (not necessarily the current text domain)
else {
$bundle = Loco_package_Plugin::create($handle);
$this->plugins[$handle] = $bundle;
}
// add current domain as translation project if not already set
// this avoids extra domains getting set before the default one
if( ! $bundle->getProject($slug) ){
$project = new Loco_package_Project( $bundle, new Loco_package_TextDomain($domain), $slug );
$bundle->addProject( $project );
}
break;
}
}
}
// failed to establish a bundle
break;
}
$this->buffered = $wasBuffered;
return $bundle;
}
/**
* @internal
* Resolve all currently buffered text domain paths
*/
private function flush(){
if( $this->buffered ){
foreach( $this->buffer as $domain => $paths ){
foreach( $paths as $path ){
try {
if( $bundle = $this->resolve($path,$domain) ){
continue 2;
}
}
catch( Loco_error_Exception $e ){
// silent errors for non-critical function
}
}
}
$this->buffer = array();
$this->buffered = false;
}
}
/**
* @return array
*/
public function getThemes(){
$this->flush();
return $this->themes;
}
/**
* @return array
*/
public function getPlugins(){
$this->flush();
return $this->plugins;
}
} src/package/Core.php 0000666 00000012376 15214141737 0010351 0 ustar 00 'default',
'DomainPath' => '/wp-content/languages/',
// dummy author info for core components
'Name' => __('WordPress core','loco-translate'),
'Version' => $GLOBALS['wp_version'],
'Author' => __('The WordPress Team','default'),
'AuthorURI' => __('https://wordpress.org/','default'),
) );
}
/**
* {@inheritdoc}
*/
public function getMetaTranslatable(){
return array();
}
/**
* {@inheritdoc}
*/
public function getType(){
return 'Core';
}
/**
* {@inheritdoc}
* Core bundle doesn't need a handle, there is only one.
*/
public function getId(){
return 'core';
}
/**
* {@inheritdoc}
* Core bundle is always configured
*/
public function isConfigured(){
$saved = parent::isConfigured() or $saved = 'internal';
return $saved;
}
/**
* Manually define the core WordPress translations as a single bundle
* Projects are those included in standard WordPress downloads: [default], "admin", "admin-network" and "continents-cities"
* @return Loco_package_Core
*/
public static function create(){
$rootDir = loco_constant('ABSPATH');
$langDir = loco_constant('WP_LANG_DIR');
$bundle = new Loco_package_Core('core', __('WordPress Core','loco-translate') );
$bundle->setDirectoryPath( $rootDir );
// Core config may be saved in DB, but not supporting bundled XML
if( $bundle->configureDb() ){
return $bundle;
}
// front end, admin and network admin packages are all part of the "default" domain
$domain = new Loco_package_TextDomain('default');
$domain->setCanonical( true );
// front end subset, has empty name in WP
// full title is like "4.9.x - Development" but we don't know what version at this point
list($x,$y) = explode('.',$GLOBALS['wp_version'],3);
$project = $domain->createProject( $bundle, sprintf('%u.%u.x - Development',$x,$y) );
$project->setSlug('')
->setPot( new Loco_fs_File($langDir.'/wordpress.pot') )
->addSourceDirectory( $rootDir)
->excludeSourcePath( $rootDir.'/wp-admin')
->excludeSourcePath( $rootDir.'/wp-content')
->excludeSourcePath( $rootDir.'/wp-includes/class-pop3.php')
->excludeSourcePath( $rootDir.'/wp-includes/js/codemirror')
->excludeSourcePath( $rootDir.'/wp-includes/js/crop')
->excludeSourcePath( $rootDir.'/wp-includes/js/imgareaselect')
->excludeSourcePath( $rootDir.'/wp-includes/js/jcrop')
->excludeSourcePath( $rootDir.'/wp-includes/js/jquery')
->excludeSourcePath( $rootDir.'/wp-includes/js/mediaelement')
->excludeSourcePath( $rootDir.'/wp-includes/js/plupload')
->excludeSourcePath( $rootDir.'/wp-includes/js/swfupload')
->excludeSourcePath( $rootDir.'/wp-includes/js/thickbox')
->excludeSourcePath( $rootDir.'/wp-includes/js/tw-sack.js')
;
// "Administration" project (admin subset)
$project = $domain->createProject( $bundle, 'Administration');
$project->setSlug('admin')
->setPot( new Loco_fs_File($langDir.'/admin.pot') )
->addSourceDirectory( $rootDir.'/wp-admin' )
->excludeSourcePath( $rootDir.'/wp-admin/js')
->excludeSourcePath( $rootDir.'/wp-admin/css')
->excludeSourcePath( $rootDir.'/wp-admin/network')
->excludeSourcePath( $rootDir.'/wp-admin/network.php')
->excludeSourcePath( $rootDir.'/wp-admin/includes/continents-cities.php')
;
// "Network Admin" package (admin-network subset)
$project = $domain->createProject($bundle, 'Network Admin');
$project->setSlug('admin-network')
->setPot( new Loco_fs_File($langDir.'/admin-network.pot') )
->addSourceDirectory( $rootDir.'/wp-admin/network' )
->addSourceFile( $rootDir.'/wp-admin/network.php' )
;
// end of "default" domain projects
$bundle->addDomain( $domain );
// Continents & Cities is its own text domain)
$domain = new Loco_package_TextDomain('continents-cities');
$project = $domain->createProject( $bundle, 'Continents & Cities');
$project->setPot( new Loco_fs_File( $langDir.'/continents-cities.pot') )
->addSourceFile( $rootDir.'/wp-admin/includes/continents-cities.php' )
;
$bundle->addDomain( $domain );
return $bundle;
}
} src/package/Header.php 0000666 00000005722 15214141737 0010646 0 ustar 00 wp = $header;
}
/**
* @return string
*/
public function __get( $prop ){
$wp = $this->wp;
// prefer require "get" method to access raw properties (WP_Theme)
if( method_exists($wp, 'get') && ( $value = $wp->get($prop) ) ){
return $value;
}
// may have key directly, e.g. TextDomain in plugin array
if( isset($wp[$prop]) ){
return $wp[$prop];
}
// else header not defined, which is probably fine
return '';
}
/**
* @codeCoverageIgnore
*/
public function __set( $prop, $value ){
throw new RuntimeException('Read only');
}
/**
* Get bundle author as linked text, just like the WordPress plugin list does
* @return string escaped HTML
*/
public function getAuthorLink(){
if( ( $link = $this->AuthorURI ) || ( $link = $this->PluginURI ) || ( $link = $this->ThemeURI ) ){
$author = $this->Author or $author = $link;
return ''.esc_html($author).'';
}
return '';
}
/**
* Get "name" by Error: '.implode('. ',$texts).'
'; } } src/compat/JsonExtension.php 0000666 00000001454 15214141737 0012152 0 ustar 00 jsonSerialize() ) * Note that this shim is also present in WordPress >= 4.4.0 */ if( ! interface_exists('JsonSerializable') ){ interface JsonSerializable { public function jsonSerialize(); } } // @codeCoverageIgnoreEnd /** * Redundant interface so this file will autoload when JsonSerializable is referenced * @internal */ interface Loco_compat_JsonSerializable extends JsonSerializable { } src/compat/MbstringExtension.php 0000666 00000003635 15214141737 0013031 0 ustar 00 */ private $cookies_set; /** * Drop all Loco data from the options table (including transients) * @return void */ protected static function dropOptions(){ global $wpdb; $query = $wpdb->prepare( "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%s' OR option_name LIKE '%s'", array('loco_%','_%_loco_%') ); if( $results = $wpdb->get_results($query,ARRAY_N) ){ foreach( $results as $row ){ list( $option_name ) = $row; delete_option( $option_name ); } } } /** * @internal */ public static function setUpBeforeClass(){ parent::setUpBeforeClass(); Loco_data_Settings::clear(); Loco_data_Session::destroy(); Loco_data_RecentItems::destroy(); self::dropOptions(); // start with default permissions as if fresh install remove_role('translator'); Loco_data_Permissions::init(); } /** * @internal */ public static function tearDownAfterClass(){ parent::tearDownAfterClass(); Loco_data_Settings::clear(); Loco_data_Session::destroy(); Loco_data_RecentItems::destroy(); wp_cache_flush(); self::dropOptions(); } /** * {@inheritdoc} */ public function setUp(){ parent::setUp(); Loco_mvc_PostParams::destroy(); Loco_error_AdminNotices::destroy(); Loco_package_Listener::destroy(); wp_cache_flush(); // text domains should be unloaded at start of all tests, and locale reset unset( $GLOBALS['locale'] ); $GLOBALS['l10n'] = array(); $this->enable_locale('en_US'); $this->assertSame( 'en_US', get_locale(), 'Ensure test site is English to start'); $this->assertSame( 'en_US', get_user_locale(),'Ensure test site is English to start'); // ensure test themes are registered and WordPress's cache is valid register_theme_directory( LOCO_TEST_DATA_ROOT.'/themes' ); $sniff = get_theme_roots(); if( ! isset($sniff['empty-theme']) ){ delete_site_transient( 'theme_roots' ); } // test plugins require a filter as multiple roots not supported in wp remove_all_filters('loco_missing_plugin'); add_filter( 'loco_missing_plugin', array(__CLASS__,'filter_allows_fake_plugins_to_exist'), 10, 2 ); // avoid WordPress missing index notices $GLOBALS['_SERVER'] += array ( 'HTTP_HOST' => 'localhost', 'SERVER_PROTOCOL' => 'HTTP/1.0', 'HTTP_USER_AGENT' => 'Loco/'.get_class($this), ); // remove all filters before adding remove_all_filters('filesystem_method'); remove_all_filters('loco_constant_DISALLOW_FILE_MODS'); remove_all_filters('file_mod_allowed'); remove_all_filters('loco_file_mod_allowed_context'); remove_all_filters('loco_setcookie'); // tests should always dictate the file system method, which defaults to direct add_filter('filesystem_method', array($this,'filter_fs_method') ); add_filter('loco_constant_DISALLOW_FILE_MODS', array($this,'filter_fs_disallow') ); add_filter('file_mod_allowed', array($this,'filter_fs_allow'), 10, 2 ); // <- wp 4.8 add_filter('loco_file_mod_allowed_context', array($this,'filter_fs_allow_context'),10,2); // <- used with file_mod_allowed // capture cookies so we can test what is set add_filter('loco_setcookie', array($this,'captureCookie'), 10, 1 ); $this->cookies_set = array(); $this->enable_network(); } /** * {@inheritdoc} */ public function clean_up_global_scope(){ parent::clean_up_global_scope(); $_COOKIE = array(); $_REQUEST = array(); } /** * Capture cookie and prevent actual http sending */ public function captureCookie( Loco_data_Cookie $cookie ){ $this->cookies_set[ $cookie->getName() ] = $cookie; return false; } /** * @return Loco_data_Cookie */ public function assertCookieSet( $name, $message = '' ){ $this->assertArrayHasKey( $name, $this->cookies_set, $message ); $cookie = $this->cookies_set[ $name ]; $this->assertInstanceOf( 'Loco_data_Cookie', $cookie, $message ); return $cookie; } /** * Invoke admin page controller without full hook set up * @return string HTML */ public static function renderPage(){ $router = new Loco_mvc_AdminRouter; $router->on_admin_menu(); $screen = get_current_screen(); $action = isset($_GET['action']) ? $_GET['action'] : null; $router->initPage( $screen, $action ); return get_echo( array($router,'renderPage') ); } /** * Invoke Ajax controller without full hook set up. * @return string JSON */ protected function renderAjax(){ wp_magic_quotes(); // <- I hate this, but it's what WP does! $router = new Loco_mvc_AjaxRouter; $router->on_init(); return $router->renderAjax(); } /** * @internal */ public function filter_fs_method( $method = '' ){ return is_null($this->fs_method) ? $method : $this->fs_method; } /** * @return Loco_test_WordPressTestCase */ public function set_fs_method( $method ){ $GLOBALS['wp_filesystem'] = null; $this->fs_method = $method; $ping = class_exists('Loco_test_DummyFtpConnect'); return $this; } /** * @return Loco_test_WordPressTestCase */ public function disable_file_mods(){ $this->fs_allow = false; return $this; } /** * Filters wp_is_file_mod_allowed for WP >= 4.8 * @internal */ public function filter_fs_allow( $bool, $context = '' ){ if( 'loco_test' === $context ){ $bool = $this->fs_allow; } return $bool; } /** * Filters DISALLOW_FILE_MODS for WP < 4.8 * @internal */ public function filter_fs_disallow(){ return ! $this->fs_allow; } /** * Filters context passed to filter_fs_allow * @internal */ public function filter_fs_allow_context( $context, Loco_fs_File $file = null ){ return 'loco_test'; } /** * Remove files created under tmp * @return void */ protected function clearTmp(){ $root = new Loco_fs_Directory( LOCO_TEST_DATA_ROOT.'/tmp' ); $dir = new Loco_fs_FileFinder( $root ); $dir->setRecursive( true ); $dirs = array(); /* @var $file Loco_fs_File */ foreach( $dir as $file ){ $dirs[ $file->dirname() ] = true; $file->unlink(); } // Be warned only directories found above will be removed foreach( array_keys($dirs) as $path ){ $dir = new Loco_fs_Directory($path); while( $dir->exists() && ! $dir->equal($root) ){ $dir->unlink(); $dir = $dir->getParent(); } } } /** * Log a mock user into WordPress * @return void */ protected function login( $role = 'administrator' ){ $wpRole = get_role($role); if( ! $wpRole ){ throw new Exception('No such role, '.$role ); } else if( ! $wpRole->capabilities ){ throw new Exception( $role.' role has no capabilities' ); } $user = self::factory()->user->create( array( 'role' => $role ) ); if( $user instanceof WP_Error ){ foreach( $user->get_error_messages() as $message ){ trigger_error( $message ); } throw new Exception('Failed to login'); } // setting user required to have proper user object $user = wp_set_current_user( $user ); // simulate default permissions used in admin menu hookage if( $user->has_cap('manage_options') ){ $user->add_cap('loco_admin'); } // simulate wp_set_auth_cookie. Can't actually set cookie cos headers $_COOKIE[LOGGED_IN_COOKIE] = wp_generate_auth_cookie( $user->ID, time()+60, 'logged_in' ); // $debug = array( 'name' => $this->getName(), 'token' => wp_get_session_token() ,'uid' => $user->ID ); // forcing new session instance new Loco_data_Session; } /** * Log out current WordPress user * @return void */ protected function logout(){ Loco_data_Session::destroy(); wp_destroy_current_session(); unset( $_COOKIE[LOGGED_IN_COOKIE] ); wp_set_current_user( 0 ); $GLOBALS['current_user'] = null; } /** * Disallow network access * @return void */ protected function disable_network(){ remove_all_filters('loco_allow_remote'); add_filter('loco_allow_remote', '__return_false' ); } /** * Enable network access * @return void */ protected function enable_network(){ remove_all_filters('loco_allow_remote'); } /** * Switch loco_debugging on * @return void */ protected function enable_debug(){ remove_all_filters('loco_debug'); add_filter('loco_debug', '__return_true' ); } /** * Switch loco_debugging off * @return void */ protected function disable_debug(){ remove_all_filters('loco_debug'); add_filter('loco_debug', '__return_false' ); } /** * Temporarily enable the "en_GB_debug" test locale * @return void */ protected function enable_debug_locale(){ return $this->enable_locale('en_GB_debug'); } /** * Temporarily enable a specific locale * @return void */ protected function enable_locale( $tag ){ $locale = Loco_Locale::parse($tag); $this->locale = (string) $locale; remove_all_filters('locale'); add_filter('locale', array($this,'_filter_locale') ); } /** * @internal */ public function _filter_locale(){ return $this->locale; } /** * Temporarily set test data root to content directory * @return void */ public function enable_test_content_dir(){ remove_all_filters('loco_constant_WP_CONTENT_DIR'); add_filter('loco_constant_WP_CONTENT_DIR', array($this,'_filter_wp_content_dir'), 10, 0 ); } /** * @internal */ public function _filter_wp_content_dir(){ return LOCO_TEST_DATA_ROOT; } /** * @internal */ public function capture_redirects(){ remove_all_filters('wp_redirect'); add_filter('wp_redirect', array($this,'filter_wp_redirect'), 10, 2 ); } /** * @internal */ public function filter_wp_redirect( $location, $status ){ $this->redirect = func_get_args(); return false; } public static function filter_allows_fake_plugins_to_exist( array $data, $handle ){ $file = LOCO_TEST_DATA_ROOT.'/plugins/'.$handle; if( file_exists($file) ) { $data = get_plugin_data($file); $snip = -strlen($handle); $data['basedir'] = substr($file,0,--$snip); } return $data; } /** * @return string location */ public function assertRedirected( $status = 302, $message = 'Failed to redirect' ){ $raw = $this->redirect; $this->assertInternalType('array', $raw, $message ); $this->assertSame( $status, $raw[1], $message ); return $raw[0]; } /** * Set $_POST * @return void */ public function setPostArray( array $post ){ $_POST = $post; $_REQUEST = array_merge( $_GET, $_POST, $_COOKIE ); $_SERVER['REQUEST_METHOD'] = 'POST'; Loco_mvc_PostParams::destroy(); } /** * Augment $_POST * @return void */ public function addPostArray( array $post ){ $this->setPostArray( $post + $_POST ); } /** * Set $_GET * @return void */ public function setGetArray( array $get ){ $_GET = $get; $_REQUEST = array_merge( $_GET, $_POST, $_COOKIE ); $_SERVER['REQUEST_METHOD'] = 'GET'; } /** * Augment $_GET * @return void */ public function addGetArray( array $get ){ $this->setGetArray( $get + $_GET ); } } src/test/DummyFtpConnect.php 0000666 00000007630 15214141740 0012113 0 ustar 00 getWriteContext()->connect( new WP_Filesystem_Debug($creds) )` */ class Loco_test_DummyFtpConnect extends Loco_hooks_Hookable { public function filter_filesystem_method(){ return 'debug'; } } /** * Dummy FTP file system. * WARNING: this actually modifies files - it just does it while simulating a remote connection * - All operations performed "direct" when authorized, else they fail. */ class WP_Filesystem_Debug extends WP_Filesystem_Base { private $authed; /** * @var WP_Error */ public $errors; public function __construct( array $opt ) { $this->options = $opt; $this->method = 'ftp'; } /** * Dummy FTP connect: requires username=foo password=xxx */ public function connect() { $this->authed = false; $this->errors = new WP_Error; // @codeCoverageIgnoreStart if( empty($this->options['hostname']) ){ $this->errors->add( 'bad_hostname', 'Debug: empty hostname'); return false; } if( empty($this->options['username']) ){ $this->errors->add( 'bad_username', 'Debug: empty username'); return false; } if( $this->options['username'] !== 'foo' ) { $this->errors->add( 'bad_username', 'Debug: username expected to be "foo"'); return false; } if( empty($this->options['password']) ){ $this->errors->add( 'bad_username', 'Debug: empty password'); return false; } if( $this->options['password'] !== 'xxx' ) { $this->errors->add( 'bad_password', 'Debug: password expected to be "xxx"' ); return false; } // @codeCoverageIgnoreEnd $this->authed = true; return true; } /** * @return WP_Filesystem_Debug */ public function disconnect(){ $this->authed = false; $this->options = array(); return $this; } /** * {@inheritdoc} * Dummy function allows exact path to be returned, subject to debugging filters */ public function find_folder( $path ){ if( WP_CONTENT_DIR === $path ){ return loco_constant('WP_CONTENT_DIR'); } return false; } /** * @internal * Proxies supposed remote call to *real* direct call, as long as instance is authorized. * Deliberately not extending WP_Filesystem_Direct for safety. */ private function _call( $method, array $args ){ if( $this->authed ){ $real = Loco_api_WordPressFileSystem::direct(); return call_user_func_array( array($real,$method), $args ); } return false; } /** * {@inheritdoc} */ public function is_writable( $file ){ return $this->_call( __FUNCTION__, func_get_args() ); } /** * {@inheritdoc} */ public function chmod( $file, $mode = false, $recursive = false ){ return $this->_call( __FUNCTION__, func_get_args() ); } /** * {@inheritdoc} */ public function copy( $source, $destination, $overwrite = false, $mode = false ){ return $this->_call( __FUNCTION__, func_get_args() ); } /** * {@inheritdoc} */ public function put_contents( $path, $data, $mode = false ){ return $this->_call( __FUNCTION__, func_get_args() ); } /** * {@inheritdoc} */ public function delete( $file, $recursive = false, $type = false ){ return $this->_call( __FUNCTION__, func_get_args() ); } /** * {@inheritdoc} */ public function mkdir( $path, $chmod = false, $chown = false, $chgrp = false ){ return $this->_call( __FUNCTION__, func_get_args() ); } } src/test/TestFilters.php 0000666 00000001015 15214141740 0011273 0 ustar 00 preserveWhitespace = false; $dom->formatOutput = false; $dom->loadXML( '',$this->escape( json_encode( $this->__debugInfo(),JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES|JSON_UNESCAPED_UNICODE ) ),''; } /** * @codeCoverageIgnore */ public function __debugInfo() { return $this->getArrayCopy(); } /** * @param callable * @return Loco_mvc_ViewParams */ public function sort( $callback ){ $raw = $this->getArrayCopy(); uasort( $raw, $callback ); $this->exchangeArray( $raw ); return $this; } } src/mvc/FileParams.php 0000666 00000012465 15214141740 0010667 0 ustar 00 = 1024 ){ $i++; $dp++; $n /= 1024; } $s = number_format( $n, $dp, '.', ',' ); // trim trailing zeros from decimal places $a = explode('.',$s); if( isset($a[1]) ){ $s = $a[0]; $d = trim($a[1],'0') and $s .= '.'.$d; } $units = array( ' bytes', ' KB', ' MB', ' GB', ' TB' ); $s .= $units[$i]; return $s; } /** * @param Loco_fs_File * @return Loco_mvc_FileParams */ public static function create( Loco_fs_File $file ) { return new Loco_mvc_FileParams( array(), $file ); } /** * Override does lazy property initialization * @param array initial extra properties * @param Loco_fs_File */ public function __construct( array $props, Loco_fs_File $file ){ parent::__construct( array ( 'name' => '', 'path' => '', 'relpath' => '', 'reltime' => '', 'bytes' => 0, 'size' => '', 'imode' => '', 'smode' => '', 'owner' => '', 'group' => '', ) + $props ); $this->file = $file; } /** * {@inheritdoc} * Override to get live information from file object */ public function offsetGet( $prop ){ $getter = array( $this, '_get_'.$prop ); if( is_callable($getter) ){ return call_user_func( $getter ); } return parent::offsetGet($prop); } /** * {@inheritdoc} * Override to ensure all properties populated */ public function getArrayCopy(){ $a = array(); foreach( $this as $prop => $dflt ){ $a[$prop] = $this[$prop]; } return $a; } /** * @internal * @return string */ private function _get_name(){ return $this->file->basename(); } /** * @internal * @return string */ private function _get_path(){ return $this->file->getPath(); } /** * @internal * @return string */ private function _get_relpath(){ return $this->file->getRelativePath( loco_constant('WP_CONTENT_DIR') ); } /** * Using slightly modified version of WordPress's Human time differencing * + Added "Just now" when in the last 30 seconds * TODO possibly replace with custom function that includes "Yesterday" etc.. * @internal * @return string */ private function _get_reltime(){ $time = $this->has('mtime') ? $this['mtime'] : $this->file->modified(); $time_diff = time() - $time; // use same time format as posts listing when in future or more than a day ago if( $time_diff < 0 || $time_diff >= 86400 ){ return date_i18n( __('Y/m/d','default'), $time ); } if( $time_diff < 30 ){ // translators: relative time when something happened in the last 30 seconds return __('Just now','loco-translate'); } return sprintf( __('%s ago','default'), human_time_diff($time) ); } /** * @internal * @return int */ private function _get_bytes(){ return $this->file->size(); } /** * @internal * @return string */ private function _get_size(){ return self::renderBytes( $this->_get_bytes() ); } /** * Get octal file mode * @internal * @return string */ private function _get_imode(){ $mode = new Loco_fs_FileMode( $this->file->mode() ); return (string) $mode; } /** * Get rwx file mode * @internal * @return string */ private function _get_smode(){ $mode = new Loco_fs_FileMode( $this->file->mode() ); return $mode->format(); } /** * Get file owner name * @internal * @return string */ private function _get_owner(){ if( ( $uid = $this->file->uid() ) && function_exists('posix_getpwuid') && ( $a = posix_getpwuid($uid) ) ){ return $a['name']; } return sprintf('%u',$uid); } /** * Get group owner name * @internal * @return string */ private function _get_group(){ if( ( $gid = $this->file->gid() ) && function_exists('posix_getpwuid') && ( $a = posix_getgrgid($gid) ) ){ return $a['name']; } return sprintf('%u',$gid); } /** * Print pseudo console line * @return string; */ public function ls(){ $this->e('smode'); echo ' '; $this->e('owner'); echo ':'; $this->e('group'); echo ' '; $this->e('relpath'); return ''; } } src/mvc/AjaxRouter.php 0000666 00000015453 15214141740 0010730 0 ustar 00 $route, 'action' => 'loco_ajax', 'loco-nonce' => wp_create_nonce($route), ); return admin_url('admin-ajax.php','relative').'?'.http_build_query($args,null,'&'); } /** * Create a new ajax router and starts buffering output immediately */ public function __construct(){ $this->buffer = Loco_output_Buffer::start(); parent::__construct(); } /** * "init" action callback. * early-ish hook that ensures controllers can initialize */ public function on_init(){ try { $class = self::routeToClass( $_REQUEST['route'] ); // autoloader will throw error if controller class doesn't exist $this->ctrl = new $class; $this->ctrl->_init( $_REQUEST ); // hook name compatible with AdminRouter do_action('loco_admin_init', $this->ctrl ); // previous hook name is deprecated if( has_action('loco_controller_init') ){ Loco_error_AdminNotices::debug('`loco_controller_init` is deprecated, use `loco_admin_init`'); do_action('loco_controller_init', $this->ctrl ); } } catch( Loco_error_Exception $e ){ $this->ctrl = null; // throw $e; // <- debug } } /** * @return string */ private static function routeToClass( $route ){ $route = explode( '-', $route ); // convert route to class name, e.g. "foo-bar" => "Loco_ajax_foo_BarController" $key = count($route) - 1; $route[$key] = ucfirst( $route[$key] ); return 'Loco_ajax_'.implode('_',$route).'Controller'; } /** * Common ajax hook for all Loco admin JSON requests * Note that tests call renderAjax directly. * @codeCoverageIgnore */ public function on_wp_ajax_loco_json(){ $json = $this->renderAjax(); $this->exitScript( $json, array ( 'Content-Type' => 'application/json; charset=UTF-8', ) ); } /** * Additional ajax hook for download actions that won't be JSON * Note that tests call renderDownload directly. * @codeCoverageIgnore */ public function on_wp_ajax_loco_download(){ $data = $this->renderDownload(); if( is_string($data) ){ $path = ( $this->ctrl ? $this->ctrl->get('path') : '' ) or $path = 'error.json'; $file = new Loco_fs_File( $path ); $ext = $file->extension(); } else if( $data instanceof Exception ){ $data = sprintf('%s in %s:%u', $data->getMessage(), basename($data->getFile()), $data->getLine() ); $ext = null; } else { $data = (string) $data; $ext = null; } $mimes = array ( 'mo' => 'application/x-gettext-translation', 'po' => 'application/x-gettext', 'pot' => 'application/x-gettext', 'xml' => 'text/xml', 'json' => 'application/json', ); $headers = array(); if( $ext && isset($mimes[$ext]) ){ $headers['Content-Type'] = $mimes[$ext].'; charset=UTF-8'; $headers['Content-Disposition'] = 'attachment; filename='.$file->basename(); } else { $headers['Content-Type'] = 'text/plain; charset=UTF-8'; } $this->exitScript( $data, $headers ); } /** * Exit script before WordPress shutdown, avoids hijacking of exit via wp_die_ajax_handler. * Also gives us a final chance to check for output buffering problems. * @codeCoverageIgnore * @param string * @param array */ private function exitScript( $str, array $headers ){ try { do_action('loco_admin_shutdown'); Loco_output_Buffer::clear(); $this->buffer = null; Loco_output_Buffer::check(); $headers['Content-Length'] = strlen($str); foreach( $headers as $name => $value ){ header( $name.': '.$value, true ); } } catch( Exception $e ){ Loco_error_AdminNotices::add( Loco_error_Exception::convert($e) ); $str = $e->getMessage(); } echo $str; exit(0); } /** * Execute Ajax controller to render JSON response body * @return string */ public function renderAjax(){ try { // respond with deferred failure from initAjax if( ! $this->ctrl ){ $route = isset($_REQUEST['route']) ? $_REQUEST['route'] : ''; throw new Loco_error_Exception( sprintf( __('Ajax route not found: "%s"','loco-translate'), $route ) ); } // else execute controller to get json output $json = $this->ctrl->render(); if( is_null($json) || '' === $json ){ throw new Loco_error_Exception( __('Ajax controller returned empty JSON','loco-translate') ); } } catch( Loco_error_Exception $e ){ $json = json_encode( array( 'error' => $e->jsonSerialize(), 'notices' => Loco_error_AdminNotices::destroyAjax() ) ); } catch( Exception $e ){ $e = Loco_error_Exception::convert($e); $json = json_encode( array( 'error' => $e->jsonSerialize(), 'notices' => Loco_error_AdminNotices::destroyAjax() ) ); } $this->buffer->discard(); return $json; } /** * Execute ajax controller to render something other than JSON * @return string|Exception */ public function renderDownload(){ try { // respond with deferred failure from initAjax if( ! $this->ctrl ){ throw new Loco_error_Exception( __('Download action not found','loco-translate') ); } // else execute controller to get raw output $data = $this->ctrl->render(); if( is_null($data) || '' === $data ){ throw new Loco_error_Exception( __('Download controller returned empty output','loco-translate') ); } } catch( Exception $e ){ $data = $e; } $this->buffer->discard(); return $data; } } src/mvc/PostParams.php 0000666 00000005125 15214141740 0010730 0 ustar 00 getArrayCopy(), false, '&' ); foreach( explode('&',$query) as $str ){ $serial[] = array_map( 'urldecode', explode( '=', $str, 2 ) ); } return $serial; } } src/mvc/AdminController.php 0000666 00000020110 15214141740 0011722 0 ustar 00 bench = microtime( true ); } $this->view = new Loco_mvc_View( $args ); $this->auth(); // check essential extensions on all pages so admin notices are shown foreach( array('json','mbstring') as $ext ){ loco_check_extension($ext); } // add contextual help tabs to current screen if there are any if( $screen = get_current_screen() ){ try { $this->view->cd('/admin/help'); $tabs = $this->getHelpTabs(); // always append common help tabs $tabs[ __('Help & support','loco-translate') ] = $this->view->render('tab-support'); // set all tabs and common side bar $i = 0; foreach( $tabs as $title => $content ){ $id = sprintf('loco-help-%u', $i++ ); $screen->add_help_tab( compact('id','title','content') ); } $screen->set_help_sidebar( $this->view->render('side-bar') ); $this->view->cd('/'); } // avoid critical errors rendering non-critical part of page catch( Loco_error_Exception $e ){ $this->view->cd('/'); Loco_error_AdminNotices::add( $e ); } } // helper properties for loading static resources $this->baseurl = plugins_url( '', loco_plugin_self() ); // add common admin page resources $this->enqueueStyle('admin', array('wp-jquery-ui-dialog') ); // load colour scheme is user has non-default $skin = get_user_option('admin_color'); if( $skin && 'fresh' !== $skin ){ $this->enqueueStyle( 'skins/'.$skin ); } // core minimized admin.js loaded on all pages before any other Loco scripts $this->enqueueScript('min/admin', array('jquery-ui-dialog') ); $this->init(); return $this; } /** * Post-construct initializer that may be overridden by child classes * @return void */ public function init(){ } /** * "admin_title" filter, modifies HTML document title if we've set one */ public function filter_admin_title( $admin_title, $title ){ if( $view_title = $this->get('title') ){ $admin_title = $view_title.' ‹ '.$admin_title; } return $admin_title; } /** * "admin_footer_text" filter, modifies admin footer only on Loco pages */ public function filter_admin_footer_text(){ $url = apply_filters('loco_external', 'https://localise.biz/'); return ''.sprintf( '%s Loco', esc_html(__('Loco Translate is powered by','loco-translate')), esc_url($url) ).''; } /** * "update_footer" filter, prints Loco version number in admin footer */ public function filter_update_footer( $text ){ $html = sprintf( 'v%s', loco_plugin_version() ); if( $this->bench && ( $info = $this->get('_debug') ) ){ $html .= sprintf('%ss', number_format_i18n($info['time'],2) ); } return $html; } /** * "loco_external" filter callback, campaignizes external links */ public function filter_loco_external( $url ){ $u = parse_url( $url ); if( isset($u['host']) && 'localise.biz' === $u['host'] ){ $query = http_build_query( array( 'utm_medium' => 'plugin', 'utm_campaign' => 'wp', 'utm_source' => 'admin', 'utm_content' => $this->get('_route') ), null, '&' ); $url = 'https://localise.biz'.$u['path']; if( isset($u['query']) ){ $url .= '?'. $u['query'].'&'.$query; } else { $url .= '?'.$query; } if( isset($u['fragment']) ){ $url .= '#'.$u['fragment']; } } return $url; } /** * All admin screens must define help tabs, even if they return empty * @return array */ public function getHelpTabs(){ return array(); } /** * {@inheritdoc} */ public function get( $prop ){ return $this->view->__get($prop); } /** * {@inheritdoc} */ public function set( $prop, $value ){ $this->view->set( $prop, $value ); return $this; } /** * Render template for echoing into admin screen * @return string */ public function view( $tpl, array $args = array() ){ /*if( ! $this->baseurl ){ throw new Loco_error_Debug('Did you mean to call $this->viewSnippet('.json_encode($tpl,JSON_UNESCAPED_SLASHES).') in '.get_class($this).'?'); }*/ $view = $this->view; foreach( $args as $prop => $value ){ $view->set( $prop, $value ); } // ensure JavaScript config always present if( $jsConf = $view->js ){ if( ! $jsConf instanceof Loco_mvc_ViewParams ){ throw new InvalidArgumentException('Bad "js" view parameter'); } } else { $jsConf = new Loco_mvc_ViewParams; $view->set( 'js', $jsConf ); } // localize script if translations in memory if( is_textdomain_loaded('loco-translate') ){ $strings = new Loco_js_Strings; $jsConf['wpl10n'] = $strings->compile(); $strings->unhook(); unset( $strings ); // add currently loaded locale for passing plural equation into js. // note that plural rules come from our data, because MO is not trusted. $tag = apply_filters( 'plugin_locale', get_locale(), 'loco-translate' ); $jsConf['wplang'] = Loco_Locale::parse($tag); } // take benchmark for debugger to be rendered in footer if( $this->bench ){ $this->set('_debug', new Loco_mvc_ViewParams( array( 'time' => microtime(true) - $this->bench, ) ) ); // additional debugging info when enabled $jsConf['WP_DEBUG'] = true; } return $view->render( $tpl ); } /** * Shortcut to render template without full page arguments as per view * @return string */ public function viewSnippet( $tpl ){ return $this->view->render( $tpl ); } /** * Add CSS to head * @return Loco_mvc_Controller */ public function enqueueStyle( $name, array $deps = array() ){ if( $base = $this->baseurl ){ $href = $base.'/pub/css/'.$name.'.css'; $vers = apply_filters( 'loco_static_version', loco_plugin_version(), $href ); wp_enqueue_style( 'loco-'.strtr($name,'/','-'), $href, $deps, $vers, 'all' ); return $this; } throw new Loco_error_Exception('Too early to enqueueStyle('.json_encode($name,JSON_UNESCAPED_SLASHES).')'); } /** * Add JavaScript to footer * @return Loco_mvc_Controller */ public function enqueueScript( $name, array $deps = array() ){ if( $base = $this->baseurl ){ $href = $base.'/pub/js/'.$name.'.js'; $vers = apply_filters( 'loco_static_version', loco_plugin_version(), $href ); wp_enqueue_script( 'loco-js-'.strtr($name,'/','-'), $href, $deps, $vers, true ); return $this; } throw new Loco_error_Exception('Too early to enqueueScript('.json_encode($name,JSON_UNESCAPED_SLASHES).')'); } } src/mvc/Controller.php 0000666 00000006351 15214141740 0010764 0 ustar 00 exitForbidden(); } /** * Emulate permission denied screen as performed in wp-admin/admin.php */ protected function exitForbidden(){ do_action( 'admin_page_access_denied' ); wp_die( __( 'You do not have sufficient permissions to access this page.','default' ), 403 ); } // @codeCoverageIgnore /** * Set a nonce for the current page for when it submits a form * @return Loco_mvc_ViewParams */ public function setNonce( $action ){ $name = 'loco-nonce'; $value = wp_create_nonce( $action ); $nonce = new Loco_mvc_ViewParams( compact('name','value','action') ); $this->set('nonce', $nonce ); return $nonce; } /** * Check if a valid nonce has been sent in current request. * Fails if nonce is invalid, but returns false if not sent so scripts can exit accordingly. * @throws Loco_error_Exception * @param string action for passing to wp_verify_nonce * @return bool true if data has been posted and nonce is valid */ public function checkNonce( $action ){ $posted = false; $name = 'loco-nonce'; if( isset($_REQUEST[$name]) ){ $value = $_REQUEST[$name]; if( wp_verify_nonce( $value, $action ) ){ $posted = true; } else { throw new Loco_error_Exception('Failed security check for '.$name); } } return $posted; } /** * Filter callback for `translations_api' * Ensures silent failure of translations_api when network disabled, see $this->getAvailableCore */ public function filter_translations_api( $value = false ){ if( apply_filters('loco_allow_remote', true ) ){ return $value; } // returning error here has the safe effect as returning empty translations list return new WP_Error( -1, 'Translations API blocked by loco_allow_remote filter' ); } /** * Filter callback for `pre_http_request` * Ensures fatal error if we failed to handle offline mode earlier. */ public function filter_pre_http_request( $value = false ){ if( apply_filters('loco_allow_remote', true ) ){ return $value; } // little point returning WP_Error error because WordPress will just show "unexpected error" throw new Loco_error_Exception('HTTP request blocked by loco_allow_remote filter' ); } } src/mvc/View.php 0000666 00000015653 15214141740 0007560 0 ustar 00 scope = new Loco_mvc_ViewParams( $args ); $this->cwd = loco_plugin_root().'/tpl'; } /** * Change base path for template paths * @param string path relative to current directory * @return Loco_mvc_View */ public function cd( $path ){ if( $path && '/' === substr($path,0,1) ){ $this->cwd = untrailingslashit( loco_plugin_root().'/tpl'.$path ); } else { $this->cwd = untrailingslashit( $this->cwd.'/'.$path ); } return $this; } /** * @internal * Clean up if something abruptly stopped rendering before graceful end */ public function __destruct(){ if( $this->block ){ ob_end_clean(); } } /** * Render error screen HTML * @param Loco_error_Exception * @return string */ public static function renderError( Loco_error_Exception $e ){ $view = new Loco_mvc_View; try { $view->set( 'error', $e ); return $view->render( $e->getTemplate() ); } catch( Exception $e ){ return '
'.htmlentities($line,ENT_COMPAT,'UTF-8').'';
// append highlighted token to current line
$j = $thisline - 1;
if( isset($code[$j]) ){
$code[$j] .= $html;
}
else {
$code[$j] = $html;
}
}
}
}
// permit limited other file types, but without back end highlighting
else if( 'js' === $type || 'twig' === $type || 'php' === $type ){
foreach( preg_split( '/\\R/u', $srcfile->getContents() ) as $line ){
$code[] = ''.htmlentities($line,ENT_COMPAT,'UTF-8').'';
}
}
else {
throw new Loco_error_Exception( sprintf('%s source view not supported', $type) ); // @codeCoverageIgnore
}
if( ! isset($code[$refline-1]) ){
throw new Loco_error_Exception( sprintf('Line %u not in source file', $refline) );
}
$this->set( 'code', $code );
return parent::render();
}
}
src/ajax/PingController.php 0000666 00000001207 15214141740 0011733 0 ustar 00 validate();
// echo back bytes posted
if( $post->has('echo') ){
$this->set( 'ping', $post['echo'] );
}
// else just send pong
else {
$this->set( 'ping', 'pong' );
}
// always send tick symbol to check json serializing of unicode
$this->set( 'utf8', "\xE2\x9C\x93" );
return parent::render();
}
} src/Locale.php 0000666 00000031612 15214141740 0007251 0 ustar 00 setSubtags( loco_parse_wp_locale($tag) );
}
catch( Exception $e ){
// isValid should return false
}
do_action( 'loco_parse_locale', $locale, $tag );
return $locale;
}
/**
* Construct from subtags NOT from composite tag. See self::parse
* Note that this skips normalization and validation steps
*/
public function __construct( $lang = '', $region = '', $variant = '' ){
$this->tag = compact('lang','region','variant');
}
/**
* @internal
* Allow read access to subtags
*/
public function __get( $t ){
return isset($this->tag[$t]) ? $this->tag[$t] : '';
}
/**
* @internal
* Allow write access to subtags
*/
public function __set( $t, $s ){
if( isset($this->tag[$t]) ){
$this->tag[$t] = $s;
$this->setSubtags( $this->tag );
}
}
/**
* Set subtags as produced from loco_parse_wp_locale
* @return Loco_Locale
*/
public function setSubtags( array $tag ){
$this->valid = false;
$default = array( 'lang' => '', 'region' => '', 'variant' => '' );
// disallow setting of unsupported tags
if( $bad = array_diff_key($tag, $default) ){
throw new Loco_error_LocaleException('Unsupported subtags: '.implode(',',$bad) );
}
$tag += $default;
// language tag is minimum requirement
if( ! $tag['lang'] ){
throw new Loco_error_LocaleException('Locale must have a language');
}
// no UN codes in Wordpress
if( is_numeric($tag['region']) ){
throw new Loco_error_LocaleException('Numeric regions not supported');
}
// single, scalar variant. Only using for Formal german currently.
if( is_array($tag['variant']) ){
$tag['variant'] = implode('_',$tag['variant']);
}
// normalize case
$tag['lang'] = strtolower($tag['lang']);
$tag['region'] = strtoupper($tag['region']);
$tag['variant'] = strtolower($tag['variant']);
// set subtags and invalidate cache of language tag
$this->tag = $tag;
$this->_tag = null;
$this->icon = null;
$this->valid = true;
return $this;
}
/**
* @return Loco_Locale
*/
public function normalize(){
try {
$this->setSubtags( $this->tag );
}
catch( Loco_error_LocaleException $e ){
$this->_tag = '';
$this->icon = null;
$this->name = 'Invalid locale';
$this->_name = null;
}
return $this;
}
/**
* @return string
*/
public function __toString(){
$str = $this->_tag;
if( is_null($str) ){
$str = implode('_',array_filter($this->tag));
$this->_tag = $str;
}
return $str;
}
/**
* Get stored name in current display language.
* Note that no dynamic translation of English name is performed, but can be altered with loco_parse_locale filter
* @return string | null
*/
public function getName(){
if( $name = $this->name ){
// use canonical native name only when current language matches
// deliberately not matching whole tag such that fr_CA would show native name of fr_FR
if( $_name = $this->getNativeName() ){
$locale = self::parse( function_exists('get_user_locale') ? get_user_locale() : get_locale() );
if( $this->lang === $locale->lang ){
$name = $_name;
}
}
return $name;
}
}
/**
* Get canonical native name as defined by WordPress
* @return string | null
*/
public function getNativeName(){
if( $name = $this->_name ){
return $name;
}
}
/**
* @return string
*/
public function getIcon(){
$icon = $this->icon;
if( is_null($icon) ){
$tag = array();
if( ! $this->tag['lang'] ){
$tag[] = 'lang lang-zxx';
}
foreach( $this->tag as $class => $code ){
if( $code ){
$tag[] = $class.' '.$class.'-'.$code;
}
}
$icon = strtolower( implode(' ',$tag) );
$this->icon = $icon;
}
return $icon;
}
/**
* @return Loco_Locale
*/
public function setIcon( $css ){
if( $css ){
$this->icon = (string) $css;
}
else {
$this->icon = null;
}
return $this;
}
/**
* @return Loco_Locale
*/
public function setName( $english_name, $native_name = '' ){
$this->name = apply_filters('loco_locale_name', $english_name, $native_name );
$this->_name = (string) $native_name;
return $this;
}
/**
* Test whether locale is valid
*/
public function isValid(){
if( is_null($this->valid) ){
$this->normalize();
}
return $this->valid;
}
/**
* Resolve this locale's "official" name from WordPress's translation api
* @return string English name currently set
*/
public function fetchName( Loco_api_WordPressTranslations $api ){
$tag = (string) $this;
// pull from WordPress translations API if network allowed
if( $locale = $api->getLocale($tag) ){
$this->setName( $locale->getName(), $locale->getNativeName() );
}
return $this->getName();
}
/**
* Resolve this locale's name from compiled Loco data
* @return string English name currently set
*/
public function buildName(){
$names = array();
// should at least have a language or not valid
if( $this->isValid() ){
$code = $this->tag['lang'];
$db = Loco_data_CompiledData::get('languages');
if( $name = $db[$code] ){
// if variant is present add only that in brackets (no lookup required)
if( $code = $this->tag['variant'] ){
$name .= ' ('.ucfirst($code).')';
}
// else add region in brackets if present
else if( $code = $this->tag['region'] ){
$db = Loco_data_CompiledData::get('regions');
if( $extra = $db[$code] ){
$name .= ' ('.$extra.')';
}
else {
$name .= ' ('.$code.')';
}
}
$this->setName( $name );
}
}
else {
$this->setName( __('Invalid locale','loco-translate') );
}
return $this->getName();
}
/**
* Ensure locale has a label, even if it has to fall back to language code or error
* @return string
*/
public function ensureName( Loco_api_WordPressTranslations $api ){
$name = $this->getName();
if( ! $name ){
$name = $this->fetchName($api);
// failing that, build own own name from components
if( ! $name ){
$name = $this->buildName();
// last resort, use tag as name
if( ! $name ){
$name = (string) $this;
$this->setName( $name );
}
}
}
return $name;
}
/**
* @return array
*/
public function jsonSerialize(){
$a = $this->tag;
$a['label'] = $this->getName();
// plural data expected by editor
$p = $this->getPluralData();
$a['pluraleq'] = $p[0];
$a['plurals'] = $p[1];
$a['nplurals'] = count($p[1]);
return $a;
}
/**
* Get plural data with translated forms
* @internal
* @return array [ (string) equation, (array) forms ]
*/
public function getPluralData(){
$cache = $this->plurals;
if( ! $cache ){
$lc = $this->lang;
$db = Loco_data_CompiledData::get('plurals');
$id = $lc && isset($db[$lc]) ? $db[$lc] : 0;
$cache = $this->setPlurals( $db[''][$id] );
}
return $cache;
}
/**
* @return int
*/
public function getPluralCount(){
$raw = $this->getPluralData();
return count( $raw[1] );
}
/**
* @return array
*/
private function setPlurals( array $raw ){
$raw = apply_filters( 'loco_locale_plurals', $raw, $this );
// handle languages with no plural forms, where n is always 0
if( ! isset($raw[1][1]) ){
// Translators: Plural category for languages that have no plurals
$raw[1] = array( _x('All forms','Plural category','loco-translate') );
$raw[0] = '0';
}
// else translate all implemented plural forms
// for meaning of categories, see http://cldr.unicode.org/index/cldr-spec/plural-rules
else {
$forms = array(
// Translators: Plural category for zero quantity
'zero' => _x('Zero','Plural category','loco-translate'),
// Translators: Plural category for singular quantity
'one' => _x('One','Plural category','loco-translate'),
// Translators: Plural category used in some multi-plural languages
'two' => _x('Two','Plural category','loco-translate'),
// Translators: Plural category used in some multi-plural languages
'few' => _x('Few','Plural category','loco-translate'),
// Translators: Plural category used in some multi-plural languages
'many' => _x('Many','Plural category','loco-translate'),
// Translators: General plural category not covered by other forms
'other' => _x('Other','Plural category','loco-translate'),
);
foreach( $raw[1] as $k => $v ){
if( isset($forms[$v]) ){
$raw[1][$k] = $forms[$v];
}
}
}
$this->plurals = $raw;
return $raw;
}
/**
* Get PO style Plural-Forms header value comprising number of forms and integer equation for n
* @return string
*/
public function getPluralFormsHeader(){
list( $equation, $forms ) = $this->getPluralData();
return sprintf('nplurals=%u; plural=%s;', count($forms), $equation );
}
/**
* Apply PO style Plural-Forms header.
* @param string e.g. "nplurals=2; plural=n != 1;"
* @return Loco_Locale
*/
public function setPluralFormsHeader( $str ){
if( ! preg_match('/^nplurals=(\\d);\s*plural=([ +\\-\\/*%!=<>|&?:()n0-9]+);?$/', $str, $match ) ){
throw new InvalidArgumentException('Invalid Plural-Forms header, '.json_encode($str) );
}
$cache = $this->getPluralData();
$exprn = $match[2];
// always alter if equation differs
if( $cache[0] !== $exprn ){
$this->plurals[0] = $exprn;
// alter number of forms if changed
$nplurals = max( 1, (int) $match[1] );
if( $nplurals !== count($cache[1]) ){
// named forms must also change, but Plural-Forms cannot contain this information
// as a cheat, we'll assume first form always "one" and last always "other"
for( $i = 1; $i < $nplurals; $i++ ){
$name = 1 === $i ? 'one' : sprintf('Plural %u',$i);
$forms[] = $name;
}
$forms[] = 'other';
$this->setPlurals( array($exprn,$forms) );
}
}
return $this;
}
/**
* @return string
*/
public function exportJson(){
return json_encode( $this->jsonSerialize() );
}
}
// Depends on compiled library
if( ! function_exists('loco_parse_wp_locale') ){
loco_include('lib/compiled/locales.php');
}
src/error/Debug.php 0000666 00000001525 15214141740 0010231 0 ustar 00 setCallee(1);
$debug->log();
}
} src/error/Success.php 0000666 00000001007 15214141740 0010606 0 ustar 00 context = null;
// If line given as 0 then treat column as offset in an unknown number of lines
if( 0 === $line ){
$lines = preg_split( '/\\r?\\n/', substr($source,0,$column));
$line = count($lines);
$column = strlen( end($lines) );
}
// get line of source code where error is and construct a ____^ thingy to show error on next line
// this requires that full source is passed in, so line number must be real
if( loco_debugging() ){
$lines = preg_split( '/\\r?\\n/', $source, $line+1 );
$offset = $line - 1;
if( isset($lines[$offset]) ){
$this->context = $lines[$offset] ."\n". str_repeat(' ', max(0,$column) ).'^';
}
}
// wrap initial message with context data
$this->message = sprintf("Error at line %u, column %u: %s", $line, $column, $this->message );
return $this;
}
/**
* @return string
*/
public function getContext(){
return $this->context;
}
}
src/error/Exception.php 0000666 00000011457 15214141740 0011146 0 ustar 00 getPrevious() ) ){
$current = $next;
}
return $current;
}
/**
* @return string
*/
public function getRealFile(){
if( $this->_file ){
return $this->_file;
}
return $this->getRootException()->getFile();
}
/**
* @return int
*/
public function getRealLine(){
if( $this->_line ){
return $this->getLine();
}
return $this->getRootException()->getLine();
}
/**
* @return array
*/
public function getRealTrace(){
return $this->getRootException()->getTrace();
}
/**
* @param int number of levels up from callee
* @return Loco_error_Exception
*/
public function setCallee( $depth = 0 ){
$stack = debug_backtrace(0);
$callee = $stack[$depth];
$this->_file = $callee['file'];
$this->_line = $callee['line'];
// TODO could also log the stack trace from $depth upwards, but not required unless being logged or thrown
return $this;
}
/**
* Write this error to file regardless of log level
* @param Loco_error_Exception
* @return void
*/
public function log(){
$file = new Loco_fs_File( $this->getRealFile() );
$path = $file->getRelativePath( loco_plugin_root() );
$text = sprintf('[Loco.%s] "%s" in %s:%u', $this->getType(), $this->getMessage(), $path, $this->getRealLine() );
// separate error log in CWD for tests
if( 'cli' === PHP_SAPI && defined('LOCO_TEST') && LOCO_TEST ){
error_log( '['.date('c').'] '.$text."\n", 3, 'debug.log' );
}
// Else write to default PHP log, but note that WordPress may have set this to wp-content/debug.log.
// If no `error_log` is set this will send message to the SAPI, so check your httpd/fast-cgi errors too.
else {
error_log( $text, 0 );
}
}
/**
* Get view template for rendering error to HTML.
* @return string path relative to root tpl directory
*/
public function getTemplate(){
return 'admin/errors/generic';
}
/**
* Get notice level short code as a string
* @return string
*/
public function getType(){
return 'error';
}
/**
* Get verbosity level
* @return int
*/
public function getLevel(){
return self::LEVEL_ERROR;
}
/**
* Get localized notice level name
* @return string
*/
public function getTitle(){
return __('Error','loco-translate');
}
/**
* @return array
*/
public function jsonSerialize(){
return array (
'code' => $this->getCode(),
'type' => $this->getType(),
'class' => get_class($this),
'title' => $this->getTitle(),
'message' => $this->getMessage(),
//'file' => str_replace( ABSPATH, '', $this->getRealFile() ),
//'line' => $this->getRealLine()
);
}
/**
* Push navigation links into error. Use for help pages etc..
* @param string
* @param string
* @return Loco_error_Exception
*/
public function addLink( $href, $text ){
$this->links[] = sprintf('%s', esc_url($href), esc_html($text) );
return $this;
}
/**
* @return array
*/
public function getLinks(){
return $this->links;
}
/**
* Convert generic exception to one of ours
* @param Exception original error
* @return Loco_error_Exception
*/
public static function convert( Exception $e ){
if( $e instanceof Loco_error_Exception ){
return $e;
}
return new Loco_error_Exception( $e->getMessage(), $e->getCode(), $e );
}
} src/error/XmlParseException.php 0000666 00000000271 15214141740 0012612 0 ustar 00 errors[] = $error;
// do late flush if we missed the boat
if( did_action('loco_admin_init') ){
$notices->on_loco_admin_init();
}
if( did_action('admin_notices') ){
$notices->on_admin_notices();
}
// if exception wasn't thrown we have to do some work to establish where it was invoked
if( __FILE__ === $error->getFile() ){
$error->setCallee(1);
}
// Log messages of minimum priority and up, depending on debug mode
// note that non-debug level is in line with error_reporting set by WordPress (notices ignored)
$priority = loco_debugging() ? Loco_error_Exception::LEVEL_DEBUG : Loco_error_Exception::LEVEL_WARNING;
if( $error->getLevel() <= $priority ){
$error->log();
}
return $error;
}
/**
* Raise a success message
* @param string
* @return Loco_error_Exception
*/
public static function success( $message ){
$notice = new Loco_error_Success($message);
return self::add( $notice->setCallee(1) );
}
/**
* Raise a failure message
* @param string
* @return Loco_error_Exception
*/
public static function err( $message ){
$notice = new Loco_error_Exception($message);
return self::add( $notice->setCallee(1) );
}
/**
* Raise a warning message
* @param string
* @return Loco_error_Exception
*/
public static function warn( $message ){
$notice = new Loco_error_Warning($message);
return self::add( $notice->setCallee(1) );
}
/**
* Raise a generic info message
* @param string
* @return Loco_error_Exception
*/
public static function info( $message ){
$notice = new Loco_error_Notice($message);
return self::add( $notice->setCallee(1) );
}
/**
* Raise a debug notice, if debug is enabled
* @param string
* @return Loco_error_Debug
*/
public static function debug( $message ){
$notice = new Loco_error_Debug($message);
$notice->setCallee(1);
loco_debugging() and self::add( $notice );
return $notice;
}
/**
* Destroy and return buffer
* @return array
*/
public static function destroy(){
if( $notices = self::$singleton ){
$buffer = $notices->errors;
$notices->errors = array();
self::$singleton = null;
return $buffer;
}
return array();
}
/**
* Destroy and return all serialized notices, suitable for ajax response
* @return array
*/
public static function destroyAjax(){
$data = array();
/* @var $notice Loco_error_Exception */
foreach( self::destroy() as $notice ){
$data[] = $notice->jsonSerialize();
}
return $data;
}
/**
* @return void
*/
private function flush(){
if( $this->errors ){
$htmls = array();
/* $var $error Loco_error_Exception */
foreach( $this->errors as $error ){
$html = sprintf (
'%s: %s
', esc_html( $error->getTitle() ), esc_html( $error->getMessage() ) ); $styles = array( 'notice', 'notice-'.$error->getType() ); if( $this->inline ){ $styles[] = 'inline'; } if( $links = $error->getLinks() ){ $styles[] = 'has-nav'; $html .= ''; } $htmls[] = 'Error: Loco Translate failed to start up
'; } /** * {@inheritdoc} */ public function __construct(){ // renders failure notice if plugin failed to start up admin hooks. add_action( 'admin_notices', array(__CLASS__,'print_hook_failure') ); // initialize hooks parent::__construct(); // Ajax router will be called directly in tests // @codeCoverageIgnoreStart if( loco_doing_ajax() ){ $action = isset($_REQUEST['action']) ? $_REQUEST['action'] : ''; // initialize Ajax router before hook fired so we can handle output buffering if( 'loco_' === substr($action,0,5) && isset($_REQUEST['route']) ){ $this->router = new Loco_mvc_AjaxRouter; Loco_package_Listener::create(); } } // @codeCoverageIgnoreEnd // page router required on all pages as it hooks in the menu else { $this->router = new Loco_mvc_AdminRouter; // we don't know we will render a page yet, but we need to listen for text domain hooks as early as possible if( isset($_GET['page']) && 'loco' === substr($_GET['page'],0,4) ){ Loco_package_Listener::create(); // trigger post-upgrade process if required $opts = Loco_data_Settings::get(); $opts->migrate(); } } } /** * "admin_init" callback. */ public function on_admin_init(){ // currently no better hook than `admin_init` for adding privacy statement. // could use "load-tools.php" action, but WordPress could change that in future. // this should fire just before WP_Privacy_Policy_Content::privacy_policy_guide is called if( function_exists('wp_add_privacy_policy_content') ) { $url = apply_filters('loco_external','https://localise.biz/wordpress/plugin/privacy'); wp_add_privacy_policy_content( __('Loco Translate','loco-translate'), esc_html( __("This plugin doesn't collect any data from public website visitors.",'loco-translate') ).'