Implement an autoloader (#4140)

* Implement an autoloader

When cleaning up classes for psr2, things got a bit unwieldy, so I implemented a class autoloader.
I created a PSR-0 compliant LibreNMS directory and moved all classes there that made sense.
Implemented LibreNMS\ClassLoader which supports adding manual class mappings

This reduces the file includes needed and only loads classes when needed.

* Add teh autoloader to graph.php

* Add a small bit of docs
Fix incomplete class in includes/discovery/functions.inc.php

LibreNMS/ClassLoader.php

@@ -0,0 +1,128 @@
+<?php
+/**
+ * ClassLoader.php
+ *
+ * PSR-0 and custom class loader for LibreNMS
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS;
+
+
+/**
+ * Class ClassLoader
+ * @package LibreNMS
+ */
+class ClassLoader
+{
+    /**
+     * @var array stores dynamically added class > file mappings
+     */
+    private $classMap;
+
+    /**
+     * ClassLoader constructor.
+     */
+    public function __construct()
+    {
+        $this->classMap = array();
+    }
+
+    /**
+     * Loads classes conforming to the PSR-0 specificaton
+     *
+     * @param string $name Class name to load
+     */
+    public static function psrLoad($name)
+    {
+        global $config, $vdebug;
+        $file = str_replace(array('\\', '_'), DIRECTORY_SEPARATOR, $name) . '.php';
+        $fullFile = $config['install_dir'] ? $config['install_dir'] . '/' . $file : $file;
+
+        if($vdebug) {
+            echo __CLASS__ . " [[ $name > $fullFile ]]\n";
+        }
+
+        if (is_readable($fullFile)) {
+            include $fullFile;
+        }
+    }
+
+    /**
+     * Loads classes defined by mapClass()
+     *
+     * @param string $name Class name to load
+     */
+    public function customLoad($name)
+    {
+        global $vdebug;
+        if (array_key_exists($name, $this->classMap)) {
+            $file = $this->classMap[$name];
+
+            if($vdebug) {
+                echo __CLASS__ . " (( $name > $file ))\n";
+            }
+
+            if (is_readable($file)) {
+                include $file;
+            }
+        }
+    }
+
+    /**
+     * Add or set a custom class > file mapping
+     *
+     * @param string $class The full class name
+     * @param string $file The path to the file containing the class, full path is preferred
+     */
+    public function mapClass($class, $file)
+    {
+        $this->classMap[$class] = $file;
+    }
+
+    /**
+     * Remove a class from the list of class > file mappings
+     *
+     * @param string $class The full class name
+     */
+    public function unMapClass($class)
+    {
+        unset($this->classMap[$class]);
+    }
+
+    /**
+     * Register this autoloader
+     * Custom mappings will take precedence over PSR-0
+     */
+    public function register()
+    {
+        spl_autoload_register(array($this, 'customLoad'));
+        spl_autoload_register(__NAMESPACE__.'\ClassLoader::psrLoad');
+    }
+
+    /**
+     * Unregister this autoloader
+     */
+    public function unregister()
+    {
+        spl_autoload_unregister(array($this, 'customLoad'));
+        spl_autoload_unregister(__NAMESPACE__.'\ClassLoader::psrLoad');
+    }
+}

LibreNMS/Component.php

@@ -1,17 +1,31 @@
 <?php
-/*
+/**
+ * Component.php
+ *
  * LibreNMS module to Interface with the Component System
  *
- * Copyright (c) 2015 Aaron Daniels <aaron@daniels.id.au>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
  *
- * This program is free software: you can redistribute it and/or modify it
+ * This program is distributed in the hope that it will be useful,
- * under the terms of the GNU General Public License as published by the
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * Free Software Foundation, either version 3 of the License, or (at your
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
- * option) any later version.  Please see LICENSE.txt at the top level of
+ * GNU General Public License for more details.
- * the source code distribution for details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2015 Aaron Daniels <aaron@daniels.id.au>
+ * @author     Aaron Daniels <aaron@daniels.id.au>
  */
 
-class component {
+namespace LibreNMS;
+
+class Component {
     /*
      * These fields are used in the component table. They are returned in the array
      * so that they can be modified but they can not be set as user attributes. We

LibreNMS/Exceptions/FileExistsException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * FileExistsException.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS\Exceptions;
+
+
+class FileExistsException extends \Exception
+{
+
+}

LibreNMS/Exceptions/HostExistsException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * HostExistsException.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS\Exceptions;
+
+
+class HostExistsException extends \Exception
+{
+
+}

LibreNMS/Exceptions/HostIpExistsException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * HostIpExistsException.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS\Exceptions;
+
+
+class HostIpExistsException extends HostExistsException
+{
+
+}

LibreNMS/Exceptions/HostUnreachableException.php

@@ -1,8 +1,8 @@
 <?php
 /**
- * exceptions.inc.php
+ * HostUnreachableException.php
  *
- * Custom Exception definitions
+ * -Description-
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,17 +23,10 @@
  * @author     Tony Murray <murraytony@gmail.com>
  */
 
+namespace LibreNMS\Exceptions;
 
-// ---- addHost Excpetions ----
-class HostExistsException extends Exception {}
 
-class HostIpExistsException extends HostExistsException {}
+class HostUnreachableException extends \Exception
-
-class InvalidPortAssocModeException extends Exception {}
-
-class SnmpVersionUnsupportedException extends Exception {}
-
-class HostUnreachableException extends Exception
 {
     protected $reasons = array();
 
@@ -64,7 +57,3 @@ class HostUnreachableException extends Exception
         return $this->reasons;
     }
 }
-
-class HostUnreachablePingException extends HostUnreachableException {}
-
-class HostUnreachableSnmpException extends HostUnreachableException {}

LibreNMS/Exceptions/HostUnreachablePingException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * HostUnreachablePingException.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS\Exceptions;
+
+
+class HostUnreachablePingException extends HostUnreachableException
+{
+
+}

LibreNMS/Exceptions/HostUnreachableSnmpException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * HostUnreachableSnmpException.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS\Exceptions;
+
+
+class HostUnreachableSnmpException extends HostUnreachableException
+{
+
+}

LibreNMS/Exceptions/InvalidPortAssocModeException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * InvalidPortAssocModeException.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS\Exceptions;
+
+
+class InvalidPortAssocModeException extends \Exception
+{
+
+}

LibreNMS/Exceptions/SnmpVersionUnsupportedException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * SnmpVersionUnsupportedException.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016 Tony Murray
+ * @author     Tony Murray <murraytony@gmail.com>
+ */
+
+namespace LibreNMS\Exceptions;
+
+
+class SnmpVersionUnsupportedException extends \Exception
+{
+
+}

LibreNMS/ObjectCache.php

@@ -1,7 +1,9 @@
 <?php
-
+/**
-/*
+ * ObjectCache.php
- * Copyright (C) 2015 Daniel Preussker <f0o@devilcode.org>
+ *
+ * -Description-
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
@@ -14,18 +16,19 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2015 Daniel Preussker <f0o@devilcode.org>
+ * @copyright  2015 LibreNMS
+ * @author     Daniel Preussker (f0o) <f0o@devilcode.org>
  */
 
-/*
+namespace LibreNMS;
- * Object-Cache
- * @author f0o <f0o@devilcode.org>
- * @copyright 2015 f0o, LibreNMS
- * @license GPL
- * @package LibreNMS
- * @subpackage Cache
- */
 
-class ObjCache implements ArrayAccess {
+use ArrayAccess;
+
+class ObjectCache implements ArrayAccess {
 
     private $data = array();
 
@@ -33,9 +36,8 @@ class ObjCache implements ArrayAccess {
 
 
     /**
-     * Initialize ObjCache
+     * Initialize ObjectCache
      * @param string $obj Name of Object
-     * @return void
      */
     public function __construct($obj) {
         global $config;

LibreNMS/Plugins.php

@@ -1,4 +1,27 @@
 <?php
+/**
+ * Plugins.php
+ *
+ * -Description-
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016
+ * @author
+ */
 
 namespace LibreNMS;
 

LibreNMS/RRDRecursiveFilterIterator.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * RRDRecursiveFilterIterator.php
+ *
+ * Reursive Filter Iterator to iterate directories and locate .rrd files.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ * @copyright  2016
+ * @author
+ */
+
+namespace LibreNMS;
+
+/**
+ * Reursive Filter Iterator to iterate directories and locate .rrd files.
+ *
+ * @method boolean isDir()
+ *
+ **/
+class RRDRecursiveFilterIterator extends \RecursiveFilterIterator {
+
+    public function accept() {
+        $filename = $this->current()->getFilename();
+        if ($filename[0] === '.') {
+            // Ignore hidden files and directories
+            return false;
+        }
+        if ($this->isDir()) {
+            // We want to search into directories
+            return true;
+        }
+        // Matches files with .rrd in the filename.
+        // We are only searching rrd folder, but there could be other files and we don't want to cause a stink.
+        return strpos($filename, '.rrd') !== false;
+    }
+}

addhost.php

@@ -12,6 +12,8 @@
  * @copyright  (C) 2006 - 2012 Adam Armstrong
  */
 
+use LibreNMS\Exceptions\HostUnreachableException;
+
 chdir(dirname($argv[0]));
 
 require 'includes/defaults.inc.php';

adduser.php

@@ -19,7 +19,6 @@ require 'includes/defaults.inc.php';
 require 'config.php';
 require 'includes/definitions.inc.php';
 require 'includes/functions.php';
-require 'html/lib/PasswordHash.php';
 
 if (file_exists('html/includes/authentication/'.$config['auth_mechanism'].'.inc.php')) {
     include 'html/includes/authentication/'.$config['auth_mechanism'].'.inc.php';

doc/Developing/Code-Structure.md

@@ -3,7 +3,10 @@
 This document will try and provide a good overview of how the code is structured within LibreNMS. We will go through the main directories and provide information on how and when they are used.
 
 ### doc/
-This is the location of all the documentation for LibreNMS, this is in GitHub markdown format and can be viewed (online)[http://docs.librenms.org/]
+This is the location of all the documentation for LibreNMS, this is in GitHub markdown format and can be viewed [online](http://docs.librenms.org/)
+
+### LibreNMS/
+Any classes should be under this directory, with a directory structure that matches the namespace.  One class per file. See [PSR-0](http://www.php-fig.org/psr/psr-0/) for details.
 
 ### html/
 All web accessible files are located here.

doc/Extensions/Component.md

@@ -70,24 +70,10 @@ Because of this all fields of the component table are reserved, they cannot be u
 
 # <a name="using">Using Components</a>
 
-To use components in you application, first you need to include the code.
+Create an instance of the component class:
-
-From a Discovery/Poller module:
 
 ```php
-require_once 'includes/component.php';
+$COMPONENT = new LibreNMS\Component();
-```
-
-From the html tree:
-
-```php
-require_once "../includes/component.php";
-```
-
-Once the code is loaded, create an instance of the component class:
-
-```php
-$COMPONENT = new component();
 ```
 
 ## <a name="get">Retrieving Components</a>
@@ -144,7 +130,7 @@ Options can be supplied to `getComponents` to influence which and how components
 You can filter on any of the [reserved](#reserved) fields. Filters are created in the following format:
 
 ```php
-$OPTIONS['filter'][FIELD] = array ('OPERATOR', 'CRITERIA');
+$options['filter']['FIELD'] = array ('OPERATOR', 'CRITERIA');
 ```
 
 Where:

html/graph.php

@@ -33,8 +33,15 @@ if (isset($_GET['debug'])) {
 require_once '../includes/defaults.inc.php';
 require_once '../config.php';
 require_once '../includes/definitions.inc.php';
+
+// initialize the class loader and add custom mappings
+require_once $config['install_dir'] . '/LibreNMS/ClassLoader.php';
+$classLoader = new LibreNMS\ClassLoader();
+$classLoader->mapClass('Console_Color2', $config['install_dir'] . '/includes/console_colour.php');
+$classLoader->mapClass('PasswordHash', $config['install_dir'] . '/html/lib/PasswordHash.php');
+$classLoader->register();
+
 require_once '../includes/common.php';
-require_once '../includes/console_colour.php';
 require_once '../includes/dbFacile.php';
 require_once '../includes/rewrites.php';
 require_once 'includes/functions.inc.php';

html/includes/api_functions.inc.php

@@ -13,7 +13,6 @@
  */
 
 require_once '../includes/functions.php';
-require_once '../includes/component.php';
 require_once '../includes/device-groups.inc.php';
 if (file_exists('../html/includes/authentication/'.$config['auth_mechanism'].'.inc.php')) {
        include '../html/includes/authentication/'.$config['auth_mechanism'].'.inc.php';
@@ -513,7 +512,7 @@ function get_components()
 
     // use hostname as device_id if it's all digits
     $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname);
-    $COMPONENT = new component();
+    $COMPONENT = new LibreNMS\Component();
     $components = $COMPONENT->getComponents($device_id, $options);
 
     $output       = array(
@@ -541,7 +540,7 @@ function add_components()
 
     // use hostname as device_id if it's all digits
     $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname);
-    $COMPONENT = new component();
+    $COMPONENT = new LibreNMS\Component();
     $component = $COMPONENT->createComponent($device_id, $ctype);
 
     $output       = array(
@@ -566,7 +565,7 @@ function edit_components()
 
     // use hostname as device_id if it's all digits
     $device_id = ctype_digit($hostname) ? $hostname : getidbyname($hostname);
-    $COMPONENT = new component();
+    $COMPONENT = new LibreNMS\Component();
 
     if ($COMPONENT->setComponentPrefs($device_id, $data)) {
         // Edit Success.
@@ -599,7 +598,7 @@ function delete_components()
     $router   = $app->router()->getCurrentRoute()->getParams();
     $cid = $router['component'];
 
-    $COMPONENT = new component();
+    $COMPONENT = new LibreNMS\Component();
     if ($COMPONENT->deleteComponent($cid)) {
         // Edit Success.
         $code     = 200;

html/includes/authenticate.inc.php

@@ -2,7 +2,6 @@
 
 @ini_set('session.use_only_cookies', 1);
 @ini_set('session.cookie_httponly', 1);
-require 'lib/PasswordHash.php';
 
 session_start();
 

html/includes/common/component-status.inc.php

@@ -1,7 +1,6 @@
 <?php
 
-require_once "../includes/component.php";
+$OBJCOMP = new LibreNMS\Component();
-$OBJCOMP = new component();
 
 $common_output[] = '
 <div>

html/includes/forms/component.inc.php

@@ -16,8 +16,7 @@ $message    = 'Error with config';
 // enable/disable components on devices.
 $device_id    = intval($_POST['device']);
 
-require_once "../includes/component.php";
+$OBJCOMP = new LibreNMS\Component();
-$OBJCOMP = new component();
 
 // Go get the component array.
 $COMPONENTS = $OBJCOMP->getComponents($device_id);

html/includes/graphs/device/cisco-otv-mac.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options['filter']['type'] = array('=','Cisco-OTV');
 $components = $component->getComponents($device['device_id'], $options);
 

html/includes/graphs/device/cisco-otv-vlan.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options['filter']['type'] = array('=','Cisco-OTV');
 $components = $component->getComponents($device['device_id'], $options);
 

html/includes/graphs/device/ntp_delay.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=','ntp');
 $components = $component->getComponents($device['device_id'], $options);

html/includes/graphs/device/ntp_dispersion.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=','ntp');
 $components = $component->getComponents($device['device_id'], $options);

html/includes/graphs/device/ntp_offset.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=','ntp');
 $components = $component->getComponents($device['device_id'], $options);

html/includes/graphs/device/ntp_stratum.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=','ntp');
 $components = $component->getComponents($device['device_id'], $options);

html/includes/graphs/port/cbqos_bufferdrops.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=','Cisco-CBQOS');
 $components = $component->getComponents($device['device_id'], $options);

html/includes/graphs/port/cbqos_qosdrops.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=','Cisco-CBQOS');
 $components = $component->getComponents($device['device_id'], $options);

html/includes/graphs/port/cbqos_traffic.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=','Cisco-CBQOS');
 $components = $component->getComponents($device['device_id'], $options);

html/includes/object-cache.inc.php

@@ -1,10 +1,10 @@
 <?php
 
-require_once $config['install_dir'].'/includes/object-cache.inc.php';
-
 // FIXME queries such as the one below should probably go into index.php?
 // FIXME: This appears to keep a complete cache of device details in memory for every page load.
 // It would be interesting to know where this is used.  It probably should have its own API.
+use LibreNMS\ObjectCache;
+
 foreach (dbFetchRows('SELECT * FROM `devices` ORDER BY `hostname`') as $device) {
     $cache['devices']['hostname'][$device['hostname']] = $device['device_id'];
     $cache['devices']['id'][$device['device_id']]      = $device;
@@ -12,9 +12,9 @@ foreach (dbFetchRows('SELECT * FROM `devices` ORDER BY `hostname`') as $device)
     $cache['device_types'][$device['type']]++;
 }
 
-$devices  = new ObjCache('devices');
+$devices  = new ObjectCache('devices');
-$ports    = new ObjCache('ports');
+$ports    = new ObjectCache('ports');
-$services = new ObjCache('services');
+$services = new ObjectCache('services');
 
 if ($devices['down']) {
     $devices['bgcolour'] = '#ffcccc';

html/includes/print-menubar.php

@@ -1,8 +1,8 @@
 <?php
-require $config['install_dir'].'/includes/object-cache.inc.php';
-
 // FIXME - this could do with some performance improvements, i think. possible rearranging some tables and setting flags at poller time (nothing changes outside of then anyways)
 
+use LibreNMS\ObjectCache;
+
 $service_status   = get_service_status();
 $typeahead_limit  = $config['webui']['global_search_result_limit'];
 $if_alerts        = dbFetchCell("SELECT COUNT(port_id) FROM `ports` WHERE `ifOperStatus` = 'down' AND `ifAdminStatus` = 'up' AND `ignore` = '0'");
@@ -247,7 +247,7 @@ if ($_SESSION['userlevel'] >= '10') {
             <li><a href="ports/"><i class="fa fa-link fa-fw fa-lg"></i> All Ports</a></li>
 
 <?php
-$ports = new ObjCache('ports');
+$ports = new ObjectCache('ports');
 
 if ($ports['errored'] > 0) {
     echo('            <li><a href="ports/errors=1/"><i class="fa fa-exclamation-circle fa-fw fa-lg"></i> Errored ('.$ports['errored'].')</a></li>');
@@ -435,8 +435,7 @@ $routing_count['ospf'] = dbFetchCell("SELECT COUNT(ospf_instance_id) FROM `ospf_
 $routing_count['cef']  = dbFetchCell("SELECT COUNT(cef_switching_id) from `cef_switching`");
 $routing_count['vrf']  = dbFetchCell("SELECT COUNT(vrf_id) from `vrfs`");
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options['type'] = 'Cisco-OTV';
 $otv = $component->getComponents(null, $options);
 $routing_count['cisco-otv'] = count($otv);
@@ -533,7 +532,7 @@ if (is_file("includes/print-menubar-custom.inc.php")) {
     <ul class="nav navbar-nav navbar-right">
       <li class="dropdown">
 <?php
-    $notifications = new ObjCache('notifications');
+    $notifications = new ObjectCache('notifications');
     $style = '';
 if (empty($notifications['count']) && empty($notifications['sticky_count'])) {
     $style = 'style="background-color:grey; color:white;"';
@@ -544,7 +543,7 @@ if (empty($notifications['count']) && empty($notifications['sticky_count'])) {
           <li role="presentation" class="dropdown-header"> Settings</li>
           <li><a href="preferences/"><i class="fa fa-cog fa-fw fa-lg"></i> My Settings</a></li>
 <?php
-    $notifications = new ObjCache('notifications');
+    $notifications = new ObjectCache('notifications');
     echo ('<li><a href="notifications/"><span class="badge count-notif">'.($notifications['sticky_count']+$notifications['count']).'</span> Notifications</a></li>');
 ?>
           <li role="presentation" class="divider"></li>

html/includes/table/component.inc.php

@@ -4,8 +4,7 @@ $row = 1;
 
 $device_id = $_POST['device_id'];
 
-require_once "../includes/component.php";
+$OBJCOMP = new LibreNMS\Component();
-$OBJCOMP = new component();
 
 // Add a filter if supplied
 if (isset($searchPhrase) && !empty($searchPhrase)) {

html/index.php

@@ -66,13 +66,10 @@ require_once '../includes/definitions.inc.php';
 require '../includes/functions.php';
 require 'includes/functions.inc.php';
 require 'includes/vars.inc.php';
-require 'includes/plugins.inc.php';
-
-use LibreNMS\Plugins;
 
 $config['memcached']['ttl'] = $config['time']['now']+300;
 
-Plugins::start();
+LibreNMS\Plugins::start();
 
 $runtime_start = microtime(true);
 

html/pages/addhost.inc.php

@@ -1,5 +1,7 @@
 <?php
 
+use LibreNMS\Exceptions\HostUnreachableException;
+
 $no_refresh = true;
 
 if ($_SESSION['userlevel'] < 10) {

html/pages/apps/ntp.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['ignore'] = array('=',0);
 $options['type'] = 'ntp';

html/pages/device.inc.php

@@ -209,8 +209,7 @@ if (device_permitted($vars['device']) || $check_device == $vars['device']) {
             $routing_tabs[] = 'vrf';
         }
 
-        require_once "../includes/component.php";
+        $component = new LibreNMS\Component();
-        $component = new component();
         $options['type'] = 'Cisco-OTV';
         $options['filter']['device_id'] = array('=',$device['device_id']);
         $otv = $component->getComponents(null, $options);

html/pages/device/apps/ntp.inc.php

@@ -11,8 +11,7 @@
  * the source code distribution for details.
  */
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['ignore'] = array('=',0);
 $options['type'] = 'ntp';

html/pages/device/overview.inc.php

@@ -32,9 +32,8 @@ echo('
     <div class="col-md-6">
 ');
 require 'includes/dev-overview-data.inc.php';
-use LibreNMS\Plugins;
 
-Plugins::call('device_overview_container', array($device));
+LibreNMS\Plugins::call('device_overview_container', array($device));
 
 require 'overview/ports.inc.php';
 echo('

html/pages/device/port.inc.php

@@ -88,8 +88,7 @@ if (dbFetchCell("SELECT COUNT(*) FROM `ports_vlans` WHERE `port_id` = '".$port['
 }
 
 // Are there any CBQoS components for this device?
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();         // Re-init array in case it has been declared previously.
 $options['filter']['type'] = array('=','Cisco-CBQOS');
 $components = $component->getComponents($device['device_id'], $options);

html/pages/device/routing/cisco-otv.inc.php

@@ -1,7 +1,6 @@
 <?php
 
-require_once "../includes/component.php";
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['ignore'] = array('=',0);
 $options['type'] = 'Cisco-OTV';

html/pages/notifications.inc.php

@@ -22,7 +22,9 @@
  * @subpackage Notifications
  */
 
-$notifications = new ObjCache('notifications');
+use LibreNMS\ObjectCache;
+
+$notifications = new ObjectCache('notifications');
 ?>
 <div class="container">
   <div class="row">

html/pages/routing/cisco-otv.inc.php

@@ -1,7 +1,6 @@
 <?php
 
-require_once "../includes/component.php";
+$COMPONENT = new LibreNMS\Component();
-$COMPONENT = new component();
 $options = array();
 $options['filter']['ignore'] = array('=',0);
 $options['type'] = 'Cisco-OTV';

includes/discovery/cisco-cbqos.inc.php

@@ -15,8 +15,7 @@ if ($device['os_group'] == 'cisco') {
 
     $module = 'Cisco-CBQOS';
 
-    require_once 'includes/component.php';
+    $component = new LibreNMS\Component();
-    $component = new component();
     $components = $component->getComponents($device['device_id'],array('type'=>$module));
 
     // We only care about our device id.

includes/discovery/cisco-otv.inc.php

@@ -59,8 +59,7 @@ if ($device['os_group'] == 'cisco') {
 
     $module = 'Cisco-OTV';
 
-    require_once 'includes/component.php';
+    $component = new LibreNMS\Component();
-    $component = new component();
     $components = $component->getComponents($device['device_id'],array('type'=>$module));
 
     // We only care about our device id.

includes/discovery/functions.inc.php

@@ -12,6 +12,8 @@
  * See COPYING for more details.
  */
 
+use LibreNMS\Exceptions\HostExistsException;
+
 function discover_new_device($hostname, $device = '', $method = '', $interface = '') {
     global $config;
 

includes/discovery/ntp/cisco.inc.php

@@ -13,8 +13,7 @@
 
 $module = 'ntp';
 
-require_once 'includes/component.php';
+$component = new LibreNMS\Component();
-$component = new component();
 $components = $component->getComponents($device['device_id'],array('type'=>$module));
 
 // We only care about our device id.

includes/functions.php

@@ -12,15 +12,31 @@
  *
  */
 
+use LibreNMS\Exceptions\HostExistsException;
+use LibreNMS\Exceptions\HostIpExistsException;
+use LibreNMS\Exceptions\HostUnreachableException;
+use LibreNMS\Exceptions\HostUnreachablePingException;
+use LibreNMS\Exceptions\InvalidPortAssocModeException;
+use LibreNMS\Exceptions\SnmpVersionUnsupportedException;
+
+
+// initialize the class loader and add custom mappings
+require_once $config['install_dir'] . '/LibreNMS/ClassLoader.php';
+$classLoader = new LibreNMS\ClassLoader();
+$classLoader->mapClass('Console_Color2', $config['install_dir'] . '/includes/console_colour.php');
+$classLoader->mapClass('Console_Table', $config['install_dir'] . '/includes/console_table.php');
+$classLoader->mapClass('PHPMailer', $config['install_dir'] . "/includes/phpmailer/class.phpmailer.php");
+$classLoader->mapClass('SMTP', $config['install_dir'] . "/includes/phpmailer/class.smtp.php");
+$classLoader->mapClass('PasswordHash', $config['install_dir'] . '/html/lib/PasswordHash.php');
+$classLoader->register();
+
 // Include from PEAR
 
 include_once("Net/IPv4.php");
 include_once("Net/IPv6.php");
 
 // Includes
-include_once($config['install_dir'] . "/includes/exceptions.inc.php");
 include_once($config['install_dir'] . "/includes/dbFacile.php");
-
 include_once($config['install_dir'] . "/includes/common.php");
 include_once($config['install_dir'] . "/includes/datastore.inc.php");
 include_once($config['install_dir'] . "/includes/billing.php");
@@ -29,15 +45,9 @@ include_once($config['install_dir'] . "/includes/syslog.php");
 include_once($config['install_dir'] . "/includes/rewrites.php");
 include_once($config['install_dir'] . "/includes/snmp.inc.php");
 include_once($config['install_dir'] . "/includes/services.inc.php");
-include_once($config['install_dir'] . "/includes/console_colour.php");
 
 $console_color = new Console_Color2();
 
-if ($config['alerts']['email']['enable']) {
-    include_once($config['install_dir'] . "/includes/phpmailer/class.phpmailer.php");
-    include_once($config['install_dir'] . "/includes/phpmailer/class.smtp.php");
-}
-
 function array_sort($array, $on, $order=SORT_ASC) {
     $new_array = array();
     $sortable_array = array();
@@ -691,8 +701,6 @@ function parse_email($emails) {
 function send_mail($emails,$subject,$message,$html=false) {
     global $config;
     if( is_array($emails) || ($emails = parse_email($emails)) ) {
-        if( !class_exists("PHPMailer",false) )
-            include_once($config['install_dir'] . "/includes/phpmailer/class.phpmailer.php");
         $mail = new PHPMailer();
         $mail->Hostname = php_uname('n');
         if (empty($config['email_from']))
@@ -1370,30 +1378,7 @@ function dnslookup($device,$type=false,$return=false) {
 }//end dnslookup
 
 
-/**
- * Reursive Filter Iterator to iterate directories and locate .rrd files.
- *
- * @method boolean isDir()
- *
-**/
 
-class RRDRecursiveFilterIterator extends \RecursiveFilterIterator {
-
-    public function accept() {
-        $filename = $this->current()->getFilename();
-        if ($filename[0] === '.') {
-            // Ignore hidden files and directories
-            return false;
-        }
-        if ($this->isDir()) {
-            // We want to search into directories
-            return true;
-        }
-        // Matches files with .rrd in the filename.
-        // We are only searching rrd folder, but there could be other files and we don't want to cause a stink.
-        return strpos($filename, '.rrd') !== false;
-    }
-}
 
 /**
  * Run rrdtool info on a file path

includes/polling/cisco-cbqos.inc.php

@@ -15,8 +15,7 @@ if ($device['os_group'] == "cisco") {
 
     $module = 'Cisco-CBQOS';
 
-    require_once 'includes/component.php';
+    $component = new LibreNMS\Component();
-    $component = new component();
     $options['filter']['type'] = array('=',$module);
     $options['filter']['disabled'] = array('=',0);
     $options['filter']['ignore'] = array('=',0);

includes/polling/cisco-otv.inc.php

@@ -59,8 +59,7 @@ if ($device['os_group'] == "cisco") {
 
     $module = 'Cisco-OTV';
 
-    require_once 'includes/component.php';
+    $component = new LibreNMS\Component();
-    $component = new component();
     $options['filter']['type'] = array('=',$module);
     $options['filter']['disabled'] = array('=',0);
     $components = $component->getComponents($device['device_id'],$options);

includes/polling/ntp/cisco.inc.php

@@ -13,8 +13,7 @@
 
 $module = 'ntp';
 
-require_once 'includes/component.php';
+$component = new LibreNMS\Component();
-$component = new component();
 $options = array();
 $options['filter']['type'] = array('=',$module);
 $options['filter']['disabled'] = array('=',0);

scripts/console-ui.php

@@ -1,8 +1,6 @@
 #!/usr/bin/env php
 <?php
 
-require '../includes/console_colour.php';
-require '../includes/console_table.php';
 require '../includes/defaults.inc.php';
 require '../config.php';
 require_once '../includes/definitions.inc.php';

snmp-scan.php

@@ -25,6 +25,10 @@
  * @subpackage Discovery
  */
 
+use LibreNMS\Exceptions\HostExistsException;
+use LibreNMS\Exceptions\HostUnreachableException;
+use LibreNMS\Exceptions\HostUnreachablePingException;
+
 $ts = microtime(true);
 
 chdir(dirname($argv[0]));
@@ -32,15 +36,14 @@ chdir(dirname($argv[0]));
 require 'includes/defaults.inc.php';
 require 'config.php';
 require 'includes/definitions.inc.php';
+require 'includes/functions.php';
+require 'includes/discovery/functions.inc.php';
 
 if ($config['autodiscovery']['snmpscan'] == false) {
     echo 'SNMP-Scan disabled.'.PHP_EOL;
     exit(2);
 }
 
-require 'includes/functions.php';
-require 'includes/discovery/functions.inc.php';
-
 function perform_snmp_scan($net) {
     global $stats, $config, $debug, $vdebug;
     echo 'Range: '.$net->network.'/'.$net->bitmask.PHP_EOL;

validate.php

@@ -307,7 +307,7 @@ foreach ($modules as $module) {
         // Loop through the rrd_dir
         $rrd_directory = new RecursiveDirectoryIterator($config['rrd_dir']);
         // Filter out any non rrd files
-        $rrd_directory_filter = new RRDRecursiveFilterIterator($rrd_directory);
+        $rrd_directory_filter = new LibreNMS\RRDRecursiveFilterIterator($rrd_directory);
         $rrd_iterator = new RecursiveIteratorIterator($rrd_directory_filter);
         $rrd_total = iterator_count($rrd_iterator);
         $rrd_iterator->rewind(); // Rewind iterator in case iterator_count left iterator in unknown state