Completed
Push — beta ( feeeb7...e84093 )
by Helmut
04:06
created

Core   B

Complexity

Total Complexity 36

Size/Duplication

Total Lines 216
Duplicated Lines 3.7 %

Coupling/Cohesion

Components 1
Dependencies 0

Test Coverage

Coverage 14.62%

Importance

Changes 0
Metric Value
dl 8
loc 216
ccs 19
cts 130
cp 0.1462
rs 8.8
c 0
b 0
f 0
wmc 36
lcom 1
cbo 0

12 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 10 1
A hasTimeshifts() 0 16 4
A add_metabox() 0 10 3
B timeshift_metabox() 0 48 5
A add_filters() 0 8 1
A update_post_metadata() 0 9 2
C inject_metadata_timeshift() 4 25 8
A inject_timeshift() 4 15 4
A add_actions() 0 12 3
A checkTable() 0 19 1
A storeTimeshift() 0 7 1
A pre_post_update() 0 20 3

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/*
3
 *
4
 *
5
 * inspired by https://github.com/adamsilverstein/wp-post-meta-revisions/blob/master/wp-post-meta-revisions.php
6
 * many thx @adamsilverstein
7
 *
8
 */
9
10
namespace KMM\Timeshift;
11
12
class Core
13
{
14
    private $plugin_dir;
15
    private $timeshift_cached_meta;
16
17 1
    public function __construct($i18n)
18
    {
19
        global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
20 1
        $this->i18n = $i18n;
0 ignored issues
show
Bug introduced by
The property i18n does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
21 1
        $this->wpdb = $wpdb;
0 ignored issues
show
Bug introduced by
The property wpdb does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
22 1
        $this->plugin_dir = plugin_dir_url(__FILE__) . '../';
23 1
        $this->add_filters();
24 1
        $this->add_actions();
25 1
        $this->add_metabox();
26
    }
27
28
    public function hasTimeshifts($post_id)
29
    {
30
        $post_type = get_post_type($post_id);
31
        $table_name = $this->wpdb->prefix . 'timeshift_' . $post_type;
32
        $this->checkTable($post_type);
33
        $sql = "select count(1) as amount from $table_name where post_id=" . $post_id;
34
        $r = $this->wpdb->get_results($sql);
35
36
        if ($r && count($r) == 1) {
37
            if (intval($r[0]->amount) > 0) {
38
                return true;
39
            }
40
        }
41
42
        return false;
43
    }
44
45 1
    public function add_metabox()
0 ignored issues
show
Coding Style introduced by
add_metabox 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...
46
    {
47 1
        $cl = $this;
48 1
        if (! isset($_GET['post']) || ! $this->hasTimeshifts($_GET['post'])) {
49 1
            return;
50
        }
51
        add_action('add_meta_boxes', function () use ($cl) {
52
            add_meta_box('krn-timeshift', __('Timeshift', 'kmm-timeshift'), [$cl, 'timeshift_metabox'], null, 'normal', 'core');
53
        });
54
    }
55
56
    public function timeshift_metabox()
0 ignored issues
show
Coding Style introduced by
timeshift_metabox 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...
57
    {
58
        global $post;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
59
        if (! isset($_GET['post'])) {
60
            return;
61
        }
62
        $prod_post = get_post($_GET['post']);
63
        $table_name = $this->wpdb->prefix . 'timeshift_' . $post->post_type;
64
        $sql = "select * from $table_name where post_id=" . $post->ID . ' order by create_date desc';
65
66
        $last_editor = get_post_meta($prod_post->ID, '_edit_last', true);
67
        $row = $this->wpdb->get_results($sql);
68
        echo '<table class="widefat fixed">';
69
        echo '<thead>';
70
        echo '<tr>';
71
        echo '<th width=30></th>';
72
        echo '<th width="40%" id="columnname" class="manage-column column-columnname"  scope="col">' . __('Title', 'kmm-timeshift') . '</th>';
73
        echo '<th width="30%" id="columnname" class="manage-column column-columnname"  scope="col">' . __('Snapshot Date', 'kmm-timeshift') . '</th>';
74
        echo '<th width="10%" id="columnname" class="manage-column column-columnname"  scope="col">' . __('Author', 'kmm-timeshift') . '</th>';
75
        echo '<th width="10%" id="columnname" class="manage-column column-columnname"  scope="col">' . __('Actions', 'kmm-timeshift') . '</th>';
76
        echo '</tr>';
77
        echo ' </thead>';
78
        echo '<tbody>';
79
        echo '<tr style="font-weight: 800;">';
80
        echo '<td>' . get_avatar($last_editor, 30) . '</td>';
81
        echo '<td>' . $prod_post->post_title . '</td>';
82
        echo '<td>' . $prod_post->post_date . '</td>';
83
        echo '<td>' . get_the_author_meta('display_name', $last_editor) . '</td>';
84
        echo "<td><a href='post.php?post=" . $_GET['post'] . "&action=edit'><span class='dashicons dashicons-admin-site'></span></A></td>";
85
        echo '</tr>';
86
87
        foreach ($row as $rev) {
88
            $timeshift = unserialize($rev->post_payload);
89
            $style = '';
90
            if (isset($_GET['timeshift']) && $_GET['timeshift'] == $rev->id) {
91
                $style = 'style="font-style:italic;background-color: lightblue;"';
92
            }
93
            echo '<tr ' . $style . '>';
94
            echo '<td>' . get_avatar($timeshift->meta['_edit_last'][0], 30) . '</td>';
95
            echo '<td>' . $timeshift->post->post_title . '</td>';
96
            echo '<td>' . $rev->create_date . '</td>';
97
            echo '<td>' . get_the_author_meta('display_name', $timeshift->meta['_edit_last'][0]) . '</td>';
98
            echo "<td><a href='post.php?post=" . $_GET['post'] . '&action=edit&timeshift=' . $rev->id . "'><span class='dashicons dashicons-backup'></span></a></td>";
99
            echo '</tr>';
100
        }
101
        echo '</tbody>';
102
        echo '</table>';
103
    }
104
105 1
    public function add_filters()
106
    {
107
        // When revisioned post meta has changed, trigger a revision save.
108
        //add_filter('wp_save_post_revision_post_has_changed', [$this, '_wp_check_revisioned_meta_fields_have_changed'], 10, 3);
0 ignored issues
show
Unused Code Comprehensibility introduced by
74% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
109
110 1
        add_filter('get_post_metadata', [$this, 'inject_metadata_timeshift'], 1, 4);
111 1
        add_filter('update_post_metadata', [$this, 'update_post_metadata'], 1, 5);
112
    }
113
114
    public function update_post_metadata($check, int $object_id, string $meta_key, $meta_value, $prev_value)
0 ignored issues
show
Unused Code introduced by
The parameter $meta_value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $prev_value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
115
    {
116
        if ($meta_key == '_edit_last') {
117
            $lo = get_post_meta($object_id, '_edit_last', true);
118
            $this->last_author = $lo;
0 ignored issues
show
Bug introduced by
The property last_author does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
119
        }
120
121
        return null;
122
    }
123
124
    public function inject_metadata_timeshift($value, $post_id, $key, $single)
0 ignored issues
show
Coding Style introduced by
inject_metadata_timeshift 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...
125
    {
126
        if (! isset($_GET['timeshift'])) {
127
            return;
128
        }
129
        //Load timeshift
130
        if (! $this->timeshift_cached_meta) {
131
            $post_type = get_post_type($post_id);
132
            $table_name = $this->wpdb->prefix . 'timeshift_' . $post_type;
133
            $sql = "select * from $table_name where id=" . intval($_GET['timeshift']);
134
            $r = $this->wpdb->get_results($sql);
135 View Code Duplication
            if ($r && count($r) == 1) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
136
                $payload = unserialize($r[0]->post_payload);
137
                $this->timeshift_cached_meta = $payload->meta;
138
            }
139
        }
140
        if ($this->timeshift_cached_meta && isset($this->timeshift_cached_meta[$key])) {
141
            return $this->timeshift_cached_meta[$key];
142
        }
143
        if ($single) {
144
            return null;
145
        }
146
147
        return [];
148
    }
149
150
    public function inject_timeshift($p)
0 ignored issues
show
Unused Code introduced by
The parameter $p is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Coding Style introduced by
inject_timeshift 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...
151
    {
152
        global $post;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
153
        if (! isset($_GET['timeshift'])) {
154
            return;
155
        }
156
        //Load timeshift
157
        $table_name = $this->wpdb->prefix . 'timeshift_' . $post->post_type;
158
        $sql = "select * from $table_name where id=" . intval($_GET['timeshift']);
159
        $r = $this->wpdb->get_results($sql);
160 View Code Duplication
        if ($r && count($r) == 1) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
161
            $payload = unserialize($r[0]->post_payload);
162
            $post = $payload->post;
163
        }
164
    }
165
166 1
    public function add_actions()
0 ignored issues
show
Coding Style introduced by
add_actions 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...
167
    {
168 1
        add_action('edit_form_top', [$this, 'inject_timeshift'], 1, 1);
169 1
        add_action('pre_post_update', [$this, 'pre_post_update'], 2, 1);
170 1
        add_action('admin_notices', function () {
171
            if (isset($_GET['timeshift']) && $_GET['timeshift']) {
172
                echo '<div class="notice notice-warning is-dismissible">
173
                         <p style="font-weight: 800; color: red">' . __('You are editing a historical version! if you save or publish, this will replace the current live one', 'kmm-timeshift') . '</p>
174
                                  </div>';
175
            }
176 1
        });
177
    }
178
179
    public function checkTable($postType)
180
    {
181
        $table_name = $this->wpdb->prefix . 'timeshift_' . $postType;
182
183
        $charset_collate = $this->wpdb->get_charset_collate();
184
185
        $sql = "CREATE TABLE IF NOT EXISTS $table_name (
186
		              id int(12) NOT NULL AUTO_INCREMENT,
187
                  post_id int(12) NOT NULL,
188
								  create_date datetime default CURRENT_TIMESTAMP,
189
									post_payload TEXT
190
		              ,PRIMARY KEY  (id)
191
	        ) $charset_collate;";
192
193
        require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
194
        $a = dbDelta($sql);
0 ignored issues
show
Unused Code introduced by
$a is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
195
196
        return true;
197
    }
198
199
    public function storeTimeshift($timeshift)
200
    {
201
        $table_name = $this->wpdb->prefix . 'timeshift_' . $timeshift->post->post_type;
202
        $sql = "insert into $table_name (post_id, post_payload) VALUES(%d, '%s')";
203
        $query = $this->wpdb->prepare($sql, $timeshift->post->ID, serialize($timeshift));
204
        $this->wpdb->query($query);
205
    }
206
207
    public function pre_post_update(int $post_ID, array $data = null)
0 ignored issues
show
Unused Code introduced by
The parameter $data is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
208
    {
209
        if (wp_is_post_autosave($post_ID)) {
210
            return;
211
        }
212
        if (get_post_status($post_ID) == 'auto-draft') {
213
            return;
214
        }
215
        $post_type = get_post_type($post_ID);
216
        $this->checkTable($post_type);
217
218
        $mdata = get_metadata('post', $post_ID);
219
        $post = get_post($post_ID);
220
221
        $mdata['_edit_last'][0] = $this->last_author;
222
        unset($mdata['_edit_lock']);
223
224
        $timeshift = (object) ['post' => $post, 'meta' => $mdata];
225
        $this->storeTimeshift($timeshift);
226
    }
227
}
228