Wordlift_Rebuild_Service::find() - Code Metrics - Inspection of "bump to 3.15.4" - insideout10/wordlift-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 20c3c4...b6edec )

by David

created 2017-11-13 14:24 UTC

Wordlift_Rebuild_Service::find() A

↳ Parent: Wordlift_Rebuild_Service

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	9
nc	1
nop	3
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Services: Rebuild Service.
 *
 * The Wordlift_Rebuild_Service allows to rebuild the Linked Data dataset from
 * scratch by clearing out data on the remote dataset, parsing all data in WordPress
 * and resending data to the remote dataset.
 *
 * @since      3.6.0
 * @package    Wordlift
 * @subpackage Wordlift/includes
 */

/**
 * Define the {@link Wordlift_Rebuild_Service} class.
 *
 * @since      3.6.0
 * @package    Wordlift
 * @subpackage Wordlift/includes
 */
class Wordlift_Rebuild_Service extends Wordlift_Listable {

	/**
	 * A {@link Wordlift_Log_Service} instance.
	 *
	 * @since  3.6.0
	 * @access private
	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
	 */
	private $log;

	/**
	 * A {@link Wordlift_Sparql_Service} instance.
	 *
	 * @since  3.6.0
	 * @access private
	 * @var \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance.
	 */
	private $sparql_service;

	/**
	 * The {@link Wordlift_Uri_Service} instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Uri_Service $uri_service The {@link Wordlift_Uri_Service} instance.
	 */
	private $uri_service;

	/**
	 * Create an instance of Wordlift_Rebuild_Service.
	 *
	 * @since 3.6.0
	 *
	 * @param \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance used to query the remote dataset.
	 * @param \Wordlift_Uri_Service    $uri_service
	 */
	public function __construct( $sparql_service, $uri_service ) {

		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rebuild_Service' );

		$this->sparql_service = $sparql_service;
		$this->uri_service    = $uri_service;
	}

	/**
	 * Rebuild the Linked Data remote dataset by clearing it out and repopulating
	 * it with local data.
	 *
	 * @since 3.6.0
	 */
	public function rebuild() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}

		ob_clean();

		// Give ourselves some time to process the data.
		set_time_limit( 21600 ); // 6 hours

		// Send textual output.
		header( 'Content-type: text/plain; charset=utf-8' );

		// We start at 0 by default and get to max.
		$offset = $_GET['offset'] ?: 0;
		$limit  = $_GET['limit'] ?: 1;
		$max    = $offset + $limit;

		// Whether we should run queries asynchronously, this is handled in `wordlift_constants.php`.
		$asynchronous = isset( $_GET['wl-async'] ) && 'true' === $_GET['wl-async'];

		// If we're starting at offset 0, then delete existing URIs and data from
		// the remote dataset.
		if ( 0 === $offset ) {

			// Clear out all generated URIs, since the dataset URI might have changed
			// in the process.
			$this->uri_service->delete_all();

			// Delete all the triples in the remote dataset.
			$this->sparql_service->execute( 'DELETE { ?s ?p ?o } WHERE { ?s ?p ?o };' );

		}

		// Go through the list of published entities and posts and call the (legacy)
		// `wl_linked_data_save_post` function for each one. We're using the `process`
		// function which is provided by the parent `Wordlift_Listable` abstract class
		// and will cycle through all the posts w/ a very small memory footprint
		// in order to avoid memory errors.

		$count = 0;
		$log   = $this->log;
		$this->process( function ( $post ) use ( &$count, $log ) {
			$count ++;
			$log->trace( "Going to save post $count, ID $post->ID..." );
			wl_linked_data_save_post( $post->ID );
		}, array(
			'post_status' => 'publish',
		), $offset, $max );

		// Redirect to the next chunk.
		if ( $count == $limit ) {
			$log->trace( 'Redirecting to post #' . ( $offset + 1 ) . '...' );
			$this->redirect( admin_url( 'admin-ajax.php?action=wl_rebuild&offset=' . ( $offset + $limit ) . '&limit=' . $limit . '&wl-async=' . ( $asynchronous ? 'true' : 'false' ) ) );
		}

		$this->log->info( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
		echo( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );

		// If we're being called as AJAX, die here.
		if ( DOING_AJAX ) {
			wp_die();
		}

	}

	/**
	 * Redirect using a client-side meta to avoid browsers' redirect restrictions.
	 *
	 * @since 3.9.8
	 *
	 * @param string $url The URL to redirect to.
	 */
	private function redirect( $url ) {

		ob_clean();

		@header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
		?>
		<html>
		<head>
			<meta http-equiv="refresh"
			      content="0; <?php echo esc_attr( $url ); ?>">
		</head>
		<body>
		Rebuilding, please wait...
		</body>
		</html>
		<?php

		exit;


	}

	/**
	 * List the items starting at the specified offset and up to the specified limit.
	 *
	 * @since 3.6.0
	 *
	 * @param int   $offset The start offset.
	 * @param int   $limit  The maximum number of items to return.
	 * @param array $args   Additional arguments.
	 *
	 * @return array A array of items (or an empty array if no items are found).
	 */
	function find( $offset = 0, $limit = 10, $args = array() ) {


		return get_posts( wp_parse_args( $args, Wordlift_Entity_Service::add_criterias( array(
			'offset'        => $offset,
			'numberposts'   => $limit,
			'fields'        => 'all',
			'orderby'       => 'ID',
			'order'         => 'ASC',
			'post_status'   => 'any',
			'cache_results' => false,
		) ) ) );
	}

}


1			<?php
2			/**
3			* Services: Rebuild Service.
4			*
5			* The Wordlift_Rebuild_Service allows to rebuild the Linked Data dataset from
6			* scratch by clearing out data on the remote dataset, parsing all data in WordPress
7			* and resending data to the remote dataset.
8			*
9			* @since 3.6.0
10			* @package Wordlift
11			* @subpackage Wordlift/includes
12			*/
13
14			/**
15			* Define the {@link Wordlift_Rebuild_Service} class.
16			*
17			* @since 3.6.0
18			* @package Wordlift
19			* @subpackage Wordlift/includes
20			*/
21			class Wordlift_Rebuild_Service extends Wordlift_Listable {
22
23			/**
24			* A {@link Wordlift_Log_Service} instance.
25			*
26			* @since 3.6.0
27			* @access private
28			* @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
29			*/
30			private $log;
31
32			/**
33			* A {@link Wordlift_Sparql_Service} instance.
34			*
35			* @since 3.6.0
36			* @access private
37			* @var \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance.
38			*/
39			private $sparql_service;
40
41			/**
42			* The {@link Wordlift_Uri_Service} instance.
43			*
44			* @since 3.15.0
45			* @access private
46			* @var \Wordlift_Uri_Service $uri_service The {@link Wordlift_Uri_Service} instance.
47			*/
48			private $uri_service;
49
50			/**
51			* Create an instance of Wordlift_Rebuild_Service.
52			*
53			* @since 3.6.0
54			*
55			* @param \Wordlift_Sparql_Service $sparql_service A {@link Wordlift_Sparql_Service} instance used to query the remote dataset.
56			* @param \Wordlift_Uri_Service $uri_service
57			*/
58			public function __construct( $sparql_service, $uri_service ) {
59
60			$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Rebuild_Service' );
61
62			$this->sparql_service = $sparql_service;
63			$this->uri_service = $uri_service;
64			}
65
66			/**
67			* Rebuild the Linked Data remote dataset by clearing it out and repopulating
68			* it with local data.
69			*
70			* @since 3.6.0
71			*/
72			public function rebuild() {
			0 ignored issues – show Coding Style introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report `rebuild` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
73
74			ob_clean();
75
76			// Give ourselves some time to process the data.
77			set_time_limit( 21600 ); // 6 hours
78
79			// Send textual output.
80			header( 'Content-type: text/plain; charset=utf-8' );
81
82			// We start at 0 by default and get to max.
83			$offset = $_GET['offset'] ?: 0;
84			$limit = $_GET['limit'] ?: 1;
85			$max = $offset + $limit;
86
87			// Whether we should run queries asynchronously, this is handled in `wordlift_constants.php`.
88			$asynchronous = isset( $_GET['wl-async'] ) && 'true' === $_GET['wl-async'];
89
90			// If we're starting at offset 0, then delete existing URIs and data from
91			// the remote dataset.
92			if ( 0 === $offset ) {
93
94			// Clear out all generated URIs, since the dataset URI might have changed
95			// in the process.
96			$this->uri_service->delete_all();
97
98			// Delete all the triples in the remote dataset.
99			$this->sparql_service->execute( 'DELETE { ?s ?p ?o } WHERE { ?s ?p ?o };' );
100
101			}
102
103			// Go through the list of published entities and posts and call the (legacy)
104			// `wl_linked_data_save_post` function for each one. We're using the `process`
105			// function which is provided by the parent `Wordlift_Listable` abstract class
106			// and will cycle through all the posts w/ a very small memory footprint
107			// in order to avoid memory errors.
108
109			$count = 0;
110			$log = $this->log;
111			$this->process( function ( $post ) use ( &$count, $log ) {
112			$count ++;
113			$log->trace( "Going to save post $count, ID $post->ID..." );
114			wl_linked_data_save_post( $post->ID );
115			}, array(
116			'post_status' => 'publish',
117			), $offset, $max );
118
119			// Redirect to the next chunk.
120			if ( $count == $limit ) {
121			$log->trace( 'Redirecting to post #' . ( $offset + 1 ) . '...' );
122			$this->redirect( admin_url( 'admin-ajax.php?action=wl_rebuild&offset=' . ( $offset + $limit ) . '&limit=' . $limit . '&wl-async=' . ( $asynchronous ? 'true' : 'false' ) ) );
123			}
124
125			$this->log->info( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
126			echo( "Rebuild complete [ count :: $count ][ limit :: $limit ]" );
127
128			// If we're being called as AJAX, die here.
129			if ( DOING_AJAX ) {
130			wp_die();
131			}
132
133			}
134
135			/**
136			* Redirect using a client-side meta to avoid browsers' redirect restrictions.
137			*
138			* @since 3.9.8
139			*
140			* @param string $url The URL to redirect to.
141			*/
142			private function redirect( $url ) {
143
144			ob_clean();
145
146			@header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
			0 ignored issues – show Security Best Practice introduced 2017-01-29 17:36 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
147			?>
148			<html>
149			<head>
150			<meta http-equiv="refresh"
151			content="0; <?php echo esc_attr( $url ); ?>">
152			</head>
153			<body>
154			Rebuilding, please wait...
155			</body>
156			</html>
157			<?php
158
159			exit;
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-29 17:36 UTC by Report Bug Copy Issue Report The method `redirect()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
160
161			}
162
163			/**
164			* List the items starting at the specified offset and up to the specified limit.
165			*
166			* @since 3.6.0
167			*
168			* @param int $offset The start offset.
169			* @param int $limit The maximum number of items to return.
170			* @param array $args Additional arguments.
171			*
172			* @return array A array of items (or an empty array if no items are found).
173			*/
174			function find( $offset = 0, $limit = 10, $args = array() ) {
			0 ignored issues – show Best Practice introduced 2016-09-16 18:06 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
175
176			return get_posts( wp_parse_args( $args, Wordlift_Entity_Service::add_criterias( array(
177			'offset' => $offset,
178			'numberposts' => $limit,
179			'fields' => 'all',
180			'orderby' => 'ID',
181			'order' => 'ASC',
182			'post_status' => 'any',
183			'cache_results' => false,
184			) ) ) );
185			}
186
187			}
188

insideout10 / wordlift-plugin

Push — master ( 20c3c4...b6edec )

Wordlift_Rebuild_Service::find() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like