midcom_services_rcs_backend_rcs - Code Metrics - Inspection of "remove some unused code" - flack/openpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (e8947e)

by Andreas

created 2016-10-21 11:05 UTC

midcom_services_rcs_backend_rcs C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	609
Duplicated Lines	8.21 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

Metric	Value
dl	50
loc	609
rs	5.5672
c	0
b	0
f	0
wmc	70
lcom	1
cbo	9

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	_generate_rcs_filename()	0	11	2
B	update()	0	31	4
B	rcs_update()	0	31	3
B	get_revision()	0	26	2
A	version_exists()	0	5	1
A	get_previous_version()	0	4	1
A	list_history_numeric()	0	5	1
A	list_history()	0	15	3
B	rcs_parse_history_entry()	0	52	6
B	rcs_gethistory()	0	29	6
A	rcs_exec()	0	17	3
A	rcs_writefile()	0	10	3
A	rcs_readfile()	0	12	3
A	rcs_object2data()	0	10	2
A	rcs_create()	0	23	3
B	exec()	0	26	3
C	get_diff()	0	63	8
A	get_comment()	0	5	1
A	restore_to_revision()	0	20	2
B	get_prev_version()	25	25	6
B	get_next_version()	25	25	6

How to fix Duplicated Code Complexity

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:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like midcom_services_rcs_backend_rcs often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use midcom_services_rcs_backend_rcs, and based on these observations, apply Extract Interface, too.

<?php
/**
 * @author tarjei huse
 * @package midcom.services.rcs
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */

/**
 * @package midcom.services.rcs
 */
class midcom_services_rcs_backend_rcs implements midcom_services_rcs_backend
namespace YourVendor;

class YourClass { }
{
    /**
     * GUID of the current object
     */
    private $_guid;

    /**
     * Cached revision history for the object
     */
    private $_history;

    private $_config;

    public function __construct($object, $config)
    {
        $this->_config = $config;
        $this->_guid = $object->guid;
    }

    private function _generate_rcs_filename($guid)
    {
        // Keep files organized to subfolders to keep filesystem sane
        $dirpath = $this->_config->get_rcs_root() . "/{$guid[0]}/{$guid[1]}";
        if (!file_exists($dirpath))
        {
            debug_add("Directory {$dirpath} does not exist, attempting to create", MIDCOM_LOG_INFO);
            mkdir($dirpath, 0777, true);
        }
        return "{$dirpath}/{$guid}";
    }

    /**
     * Save a new revision
     *
     * @param object object to be saved
     * @return boolean true on success.
     */
    public function update($object, $updatemessage = null)
// 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);
    }
}
    {
        // Store user identifier and IP address to the update string
        if (midcom::get()->auth->user)
        {
            $update_string = midcom::get()->auth->user->id . "|{$_SERVER['REMOTE_ADDR']}";
        }
        else
        {
            $update_string = "NOBODY|{$_SERVER['REMOTE_ADDR']}";
        }

        // Generate update message if needed
        if (!$updatemessage)
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
        {
            if (midcom::get()->auth->user !== null)
            {
                $updatemessage = sprintf("Updated on %s by %s", strftime("%x %X"), midcom::get()->auth->user->name);
            }
            else
            {
                $updatemessage = sprintf("Updated on %s.", strftime("%x %X"));
            }
        }
        $update_string .= "|{$updatemessage}";

        $result = $this->rcs_update($object, $update_string);

        // The methods return basically what the RCS unix level command returns, so nonzero value is error and zero is ok...
        return ($result == 0);

    }

    /**
     * Update object to RCS
     * Should be called just before $object->update(), if the type parameter is omitted
     * the function will use GUID to determine the type, this makes an extra DB query.
     *
     * @param string root of rcs directory.
     * @param object object to be updated.
     * @return int :
     *      0 on success
     *      3 on missing object->guid
     *      nonzero on error in one of the commands.
     */
    public function rcs_update ($object, $message)
    {
        if (empty($object->guid))
        {
            debug_add("Missing GUID, returning error");
            return 3;
        }

        $filename = $this->_generate_rcs_filename($object->guid);
        $rcsfilename =  "{$filename},v";

        if (!file_exists($rcsfilename))
        {
            $message = str_replace('|Updated ', '|Created ', $message);
            // The methods return basically what the RCS unix level command returns, so nonzero value is error and zero is ok...
            return $this->rcs_create($object, $message);
        }

        $command = 'co -q -f -l ' . escapeshellarg($filename);
        $this->exec($command);

        $data = $this->rcs_object2data($object);

        $this->rcs_writefile($object->guid, $data);
        $command = 'ci -q -m' . escapeshellarg($message) . " {$filename}";
        $status = $this->exec($command);

        chmod ($rcsfilename, 0770);

        return $status;
    }

   /**
    * Get the object of a revision
    *
    * @param string revision identifier of revision wanted
    * @return array array representation of the object
    */
    public function get_revision($revision)
    {
        if (empty($this->_guid))
        {
            return array();
        }
        $filepath = $this->_generate_rcs_filename($this->_guid);

        // , must become . to work. Therefore this:
        str_replace(',', '.', $revision );
        // this seems to cause problems:
        //settype ($revision, "float");

        $command = 'co -q -f -r' . escapeshellarg(trim($revision)) .  " {$filepath} 2>/dev/null";
        $this->exec($command);

        $data = $this->rcs_readfile($this->_guid);

        $mapper = new midcom_helper_exporter_xml();
        $revision = $mapper->data2array($data);

        $command = "rm -f {$filepath}";
        $this->exec($command);

        return $revision;
    }

    /**
     * Check if a revision exists
     *
     * @param string  version
     * @return booleann true if exists
     */
    public function version_exists($version)
    {
        $history = $this->list_history();
        return array_key_exists($version, $history);
    }

    /**
     * Get the previous versionID
     *
     * @param string version
     * @return string versionid before this one or empty string.
     */
    public function get_prev_version($version)

    {
        $versions = $this->list_history_numeric();

        if (   !in_array($version, $versions)
            || $version === end($versions))
        {
            return '';
        }

        $mode = end($versions);

        while( $mode
            && $mode !== $version)
        {
            $mode = prev($versions);

            if ($mode === $version)
            {
                return next($versions);
            }
        }

        return '';
    }

    /**
     * Mirror method for get_prev_version()
     *
     * @param string $version
     * @return mixed
     */
    public function get_previous_version($version)
    {
        return $this->get_prev_version($version);
    }

    /**
     * Get the next versionID
     *
     * @param string version
     * @return string versionid before this one or empty string.
     */
    public function get_next_version($version)

    {
        $versions = $this->list_history_numeric();

        if (   !in_array($version, $versions)
            || $version === current($versions))
        {
            return '';
        }

        $mode = current($versions);

        while (   $mode
               && $mode !== $version)
        {
            $mode = next($versions);

            if ($mode === $version)
            {
                return prev($versions);
            }
        }

        return '';
    }

    /**
     * Return a list of the revisions as a key => value pair where
     * the key is the index of the revision and the value is the revision id.
     * Order: revision 0 is the newest.
     *
     * @return array
     */
    public function list_history_numeric()
    {
        $revs = $this->list_history();
        return array_keys($revs);
    }

    /**
     * Lists the number of changes that has been done to the object
     *
     * @return array list of changeids
     */
    public function list_history()
    {
        if (empty($this->_guid))
        {
            return array();
        }

        if (is_null($this->_history))
        {
            $filepath = $this->_generate_rcs_filename($this->_guid);
            $this->_history = $this->rcs_gethistory($filepath);
        }

        return $this->_history;
    }

    /* it is debatable to move this into the object when it resides nicely in a libary... */

    private function rcs_parse_history_entry($entry)
    {
        // Create the empty history array
        $history = array
        (
            'revision' => null,
            'date'     => null,
            'lines'    => null,
            'user'     => null,
            'ip'       => null,
            'message'  => null,
        );

        // Revision number is in format
        // revision 1.11
        $history['revision'] = substr($entry[0], 9);

        // Entry metadata is in format
        // date: 2006/01/10 09:40:49;  author: www-data;  state: Exp;  lines: +2 -2
        // NOTE: Time here appears to be stored as UTC according to http://parand.com/docs/rcs.html
        $metadata_array = explode(';', $entry[1]);
        foreach ($metadata_array as $metadata)
        {
            $metadata = trim($metadata);
            if (substr($metadata, 0, 5) == 'date:')
            {
                $history['date'] = strtotime(substr($metadata, 6));
            }
            elseif (substr($metadata, 0, 6) == 'lines:')
            {
                $history['lines'] = substr($metadata, 7);
            }
        }

        // Entry message is in format
        // user:27b841929d1e04118d53dd0a45e4b93a|84.34.133.194|Updated on Tue 10.Jan 2006 by admin kw
        $message_array = explode('|', $entry[2]);
        if (count($message_array) == 1)
        {
            $history['message'] = $message_array[0];
        }
        else
        {
            if ($message_array[0] != 'Object')
            {
                $history['user'] = $message_array[0];
            }
            $history['ip']   = $message_array[1];
            $history['message'] = $message_array[2];
        }
        return $history;
    }

    /*
     * the functions below are mostly rcs functions moved into the class. Someday I'll get rid of the
     * old files...
     */
    /**
     * Get a list of the object's history
     *
     * @param string objectid (usually the guid)
     * @return array list of revisions and revision comment.
     */
    private function rcs_gethistory($what)
    {
        $history = $this->rcs_exec('rlog', $what . ',v');
        $revisions = array();
        $lines = explode("\n", $history);

        for ($i = 0; $i < count($lines); $i++)
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
        {
            if (substr($lines[$i], 0, 9) == "revision ")
            {
                $history_entry[0] = $lines[$i];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                $history_entry[1] = $lines[$i+1];
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                $history_entry[2] = $lines[$i+2];
                $history = $this->rcs_parse_history_entry($history_entry);

                $revisions[$history['revision']] = $history;

                $i += 3;

                while (   $i < count($lines)
                       && substr($lines[$i], 0, 4) != '----'
                       && substr($lines[$i], 0, 5) != '=====')
                {
                     $i++;
                }
            }
        }
        return $revisions;
    }

    /**
     * execute a command
     *
     * @param string $command The command to execute
     * @param string $filename The file to operate on
     * @return string command result.
     */
    private function rcs_exec($command, $filename)
    {
        if (!is_readable($filename))
        {
            debug_add('file ' . $filename . ' is not readable, returning empty result', MIDCOM_LOG_INFO);
            return '';
        }
        $fh = popen($command . ' "' . $filename . '" 2>&1', "r");
        $ret = "";
        while ($reta = fgets($fh, 1024))
        {
            $ret .= $reta;
        }
        pclose($fh);

        return $ret;
    }

    /**
     * Writes $data to file $guid, does not return anything.
     */
    private function rcs_writefile ($guid, $data)
    {
        if (   !is_writable($this->_config->get_rcs_root())
            || empty($guid))
        {
            return false;
        }
        $filename = $this->_generate_rcs_filename($guid);
        file_put_contents($filename, $data);
    }

    /**
     * Reads data from file $guid and returns it.
     *
     * @param string guid
     * @return string xml representation of guid
     */
    private function rcs_readfile ($guid)
    {
        if (!empty($guid))
        {
            $filename = $this->_generate_rcs_filename($guid);
            if (file_exists($filename))
            {
                return file_get_contents($filename);
            }
        }
        return '';
    }

    /**
     * Make xml out of an object.
     *
     * @param midcom_core_dbaobject $object
     * @return xmldata
     */
    private function rcs_object2data(midcom_core_dbaobject $object)
    {
        $mapper = new midcom_helper_exporter_xml();
        if ($result = $mapper->object2data($object))
        {
            return $result;
        }
        debug_add("Objectmapper returned false.");
        return false;
    }

    /**
     * Add object to RCS
     *
     * @param object $object object to be saved
     * @param string $description changelog comment.-
     * @return int :
     *      0 on success
     *      3 on missing object->guid
     *      nonzero on error in one of the commands.
     */
    private function rcs_create(midcom_core_dbaobject $object, $description)
    {
        $data = $this->rcs_object2data($object);

        if (empty($object->guid))
        {
            return 3;
        }
        $this->rcs_writefile($object->guid, $data);
        $filepath = $this->_generate_rcs_filename($object->guid);

        $command = 'ci -q -i -t-' . escapeshellarg($description) . ' -m' . escapeshellarg($description) . " {$filepath}";

        $status = $this->exec($command);

        $filename = $filepath . ",v";

        if (file_exists($filename))
        {
            chmod ($filename, 0770);
        }
        return $status;
    }

    private function exec($command)
    {
        $status = null;
        $output = null;

        // Always append stderr redirect
        $command .= ' 2>&1';

        debug_add("Executing '{$command}'");

        try
        {
            @exec($command, $output, $status);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
        catch (Exception $e)
        {
            debug_add($e->getMessage());
        }

        if ($status !== 0)
        {
            debug_add("Command '{$command}' returned with status {$status}, see debug log for output", MIDCOM_LOG_WARN);
            debug_print_r('Got output: ', $output);
        }
        return $status;
    }

    /**
     * Get a html diff between two versions.
     *
     * @param string latest_revision id of the latest revision
     * @param string oldest_revision id of the oldest revision
     * @return array array with the original value, the new value and a diff -u
     */
    public function get_diff($oldest_revision, $latest_revision, $renderer_style = 'inline')
    {
        $oldest = $this->get_revision($oldest_revision);
        $newest = $this->get_revision($latest_revision);

        $return = array();
        $oldest = array_intersect_key($oldest, $newest);

        $repl = array(
            '<del>' => "<span class=\"deleted\">",
            '</del>' => '</span>',
            '<ins>' => "<span class=\"inserted\">",
            '</ins>' => '</span>'
        );
        foreach ($oldest as $attribute => $oldest_value)
        {
            if (is_array($oldest_value))
            {
                continue;
            }

            $return[$attribute] = array
            (
                'old' => $oldest_value,
                'new' => $newest[$attribute]
            );

            if ($oldest_value != $newest[$attribute])
            {
                $lines1 = explode ("\n", $oldest_value);
                $lines2 = explode ("\n", $newest[$attribute]);

                $options = array();
                $diff = new Diff($lines1, $lines2, $options);
                if ($renderer_style == 'unified')
                {
                    $renderer = new Diff_Renderer_Text_Unified;
                }
                else
                {
                    $renderer = new midcom_services_rcs_renderer_html_sidebyside(array('old' => $oldest_revision, 'new' => $latest_revision));
                }

                if ($lines1 != $lines2)
                {
                    // Run the diff
                    $return[$attribute]['diff'] = $diff->render($renderer);
                    if ($renderer_style == 'unified')
                    {
                        $return[$attribute]['diff'] = htmlspecialchars($return[$attribute]['diff']);
                    }

                    if ($renderer_style == 'inline')
                    {
                        // Modify the output for nicer rendering
                        $return[$attribute]['diff'] = strtr($return[$attribute]['diff'], $repl);
                    }
                }
            }
        }

        return $return;
    }

    /**
     * Get the comment of one revision.
     *
     * @param string revison id
     * @return string comment
     */
    public function get_comment($revision)
    {
        $this->list_history();
        return $this->_history[$revision];
    }

    /**
     * Restore an object to a certain revision.
     *
     * @param string id of revision to restore object to.
     * @return boolean true on success.
     */
    public function restore_to_revision($revision)
    {
        $new = $this->get_revision($revision);

        try
        {
            $object = midcom::get()->dbfactory->get_object_by_guid($this->_guid);
        }
        catch (midcom_error $e)
        {
            debug_add("{$this->_guid} could not be resolved to object", MIDCOM_LOG_ERROR);
            return false;
        }
        $mapper = new midcom_helper_exporter_xml();
        $object = $mapper->data2object($new, $object);

        $object->set_rcs_message("Reverted to revision {$revision}");

        return $object->update();
    }
}


flack / openpsa