Completed
Pull Request — master (#4454)
by Lukas
13:37
created
apps/user_ldap/lib/Command/DeleteConfig.php 1 patch
Indentation   +29 added lines, -29 removed lines patch added patch discarded remove patch
@@ -33,39 +33,39 @@
 block discarded – undo
33 33
 use Symfony\Component\Console\Output\OutputInterface;
34 34
 
35 35
 class DeleteConfig extends Command {
36
-	/** @var \OCA\User_LDAP\Helper */
37
-	protected $helper;
36
+    /** @var \OCA\User_LDAP\Helper */
37
+    protected $helper;
38 38
 
39
-	/**
40
-	 * @param Helper $helper
41
-	 */
42
-	public function __construct(Helper $helper) {
43
-		$this->helper = $helper;
44
-		parent::__construct();
45
-	}
39
+    /**
40
+     * @param Helper $helper
41
+     */
42
+    public function __construct(Helper $helper) {
43
+        $this->helper = $helper;
44
+        parent::__construct();
45
+    }
46 46
 
47
-	protected function configure() {
48
-		$this
49
-			->setName('ldap:delete-config')
50
-			->setDescription('deletes an existing LDAP configuration')
51
-			->addArgument(
52
-					'configID',
53
-					InputArgument::REQUIRED,
54
-					'the configuration ID'
55
-				     )
56
-		;
57
-	}
47
+    protected function configure() {
48
+        $this
49
+            ->setName('ldap:delete-config')
50
+            ->setDescription('deletes an existing LDAP configuration')
51
+            ->addArgument(
52
+                    'configID',
53
+                    InputArgument::REQUIRED,
54
+                    'the configuration ID'
55
+                        )
56
+        ;
57
+    }
58 58
 
59 59
 
60
-	protected function execute(InputInterface $input, OutputInterface $output) {
61
-		$configPrefix = $input->getArgument('configID');
60
+    protected function execute(InputInterface $input, OutputInterface $output) {
61
+        $configPrefix = $input->getArgument('configID');
62 62
 
63
-		$success = $this->helper->deleteServerConfiguration($configPrefix);
63
+        $success = $this->helper->deleteServerConfiguration($configPrefix);
64 64
 
65
-		if($success) {
66
-			$output->writeln("Deleted configuration with configID '{$configPrefix}'");
67
-		} else {
68
-			$output->writeln("Cannot delete configuration with configID '{$configPrefix}'");
69
-		}
70
-	}
65
+        if($success) {
66
+            $output->writeln("Deleted configuration with configID '{$configPrefix}'");
67
+        } else {
68
+            $output->writeln("Cannot delete configuration with configID '{$configPrefix}'");
69
+        }
70
+    }
71 71
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Command/TestConfig.php 1 patch
Indentation   +50 added lines, -50 removed lines patch added patch discarded remove patch
@@ -34,59 +34,59 @@
 block discarded – undo
34 34
 
35 35
 class TestConfig extends Command {
36 36
 
37
-	protected function configure() {
38
-		$this
39
-			->setName('ldap:test-config')
40
-			->setDescription('tests an LDAP configuration')
41
-			->addArgument(
42
-					'configID',
43
-					InputArgument::REQUIRED,
44
-					'the configuration ID'
45
-				     )
46
-		;
47
-	}
37
+    protected function configure() {
38
+        $this
39
+            ->setName('ldap:test-config')
40
+            ->setDescription('tests an LDAP configuration')
41
+            ->addArgument(
42
+                    'configID',
43
+                    InputArgument::REQUIRED,
44
+                    'the configuration ID'
45
+                        )
46
+        ;
47
+    }
48 48
 
49
-	protected function execute(InputInterface $input, OutputInterface $output) {
50
-		$helper = new Helper(\OC::$server->getConfig());
51
-		$availableConfigs = $helper->getServerConfigurationPrefixes();
52
-		$configID = $input->getArgument('configID');
53
-		if(!in_array($configID, $availableConfigs)) {
54
-			$output->writeln("Invalid configID");
55
-			return;
56
-		}
49
+    protected function execute(InputInterface $input, OutputInterface $output) {
50
+        $helper = new Helper(\OC::$server->getConfig());
51
+        $availableConfigs = $helper->getServerConfigurationPrefixes();
52
+        $configID = $input->getArgument('configID');
53
+        if(!in_array($configID, $availableConfigs)) {
54
+            $output->writeln("Invalid configID");
55
+            return;
56
+        }
57 57
 
58
-		$result = $this->testConfig($configID);
59
-		if($result === 0) {
60
-			$output->writeln('The configuration is valid and the connection could be established!');
61
-		} else if($result === 1) {
62
-			$output->writeln('The configuration is invalid. Please have a look at the logs for further details.');
63
-		} else if($result === 2) {
64
-			$output->writeln('The configuration is valid, but the Bind failed. Please check the server settings and credentials.');
65
-		} else {
66
-			$output->writeln('Your LDAP server was kidnapped by aliens.');
67
-		}
68
-	}
58
+        $result = $this->testConfig($configID);
59
+        if($result === 0) {
60
+            $output->writeln('The configuration is valid and the connection could be established!');
61
+        } else if($result === 1) {
62
+            $output->writeln('The configuration is invalid. Please have a look at the logs for further details.');
63
+        } else if($result === 2) {
64
+            $output->writeln('The configuration is valid, but the Bind failed. Please check the server settings and credentials.');
65
+        } else {
66
+            $output->writeln('Your LDAP server was kidnapped by aliens.');
67
+        }
68
+    }
69 69
 
70
-	/**
71
-	 * tests the specified connection
72
-	 * @param string $configID
73
-	 * @return int
74
-	 */
75
-	protected function testConfig($configID) {
76
-		$lw = new \OCA\User_LDAP\LDAP();
77
-		$connection = new Connection($lw, $configID);
70
+    /**
71
+     * tests the specified connection
72
+     * @param string $configID
73
+     * @return int
74
+     */
75
+    protected function testConfig($configID) {
76
+        $lw = new \OCA\User_LDAP\LDAP();
77
+        $connection = new Connection($lw, $configID);
78 78
 
79
-		//ensure validation is run before we attempt the bind
80
-		$connection->getConfiguration();
79
+        //ensure validation is run before we attempt the bind
80
+        $connection->getConfiguration();
81 81
 
82
-		if(!$connection->setConfiguration(array(
83
-			'ldap_configuration_active' => 1,
84
-		))) {
85
-			return 1;
86
-		}
87
-		if($connection->bind()) {
88
-			return 0;
89
-		}
90
-		return 2;
91
-	}
82
+        if(!$connection->setConfiguration(array(
83
+            'ldap_configuration_active' => 1,
84
+        ))) {
85
+            return 1;
86
+        }
87
+        if($connection->bind()) {
88
+            return 0;
89
+        }
90
+        return 2;
91
+    }
92 92
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Command/SetConfig.php 1 patch
Indentation   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -34,53 +34,53 @@
 block discarded – undo
34 34
 
35 35
 class SetConfig extends Command {
36 36
 
37
-	protected function configure() {
38
-		$this
39
-			->setName('ldap:set-config')
40
-			->setDescription('modifies an LDAP configuration')
41
-			->addArgument(
42
-					'configID',
43
-					InputArgument::REQUIRED,
44
-					'the configuration ID'
45
-				     )
46
-			->addArgument(
47
-					'configKey',
48
-					InputArgument::REQUIRED,
49
-					'the configuration key'
50
-				     )
51
-			->addArgument(
52
-					'configValue',
53
-					InputArgument::REQUIRED,
54
-					'the new configuration value'
55
-				     )
56
-		;
57
-	}
37
+    protected function configure() {
38
+        $this
39
+            ->setName('ldap:set-config')
40
+            ->setDescription('modifies an LDAP configuration')
41
+            ->addArgument(
42
+                    'configID',
43
+                    InputArgument::REQUIRED,
44
+                    'the configuration ID'
45
+                        )
46
+            ->addArgument(
47
+                    'configKey',
48
+                    InputArgument::REQUIRED,
49
+                    'the configuration key'
50
+                        )
51
+            ->addArgument(
52
+                    'configValue',
53
+                    InputArgument::REQUIRED,
54
+                    'the new configuration value'
55
+                        )
56
+        ;
57
+    }
58 58
 
59
-	protected function execute(InputInterface $input, OutputInterface $output) {
60
-		$helper = new Helper(\OC::$server->getConfig());
61
-		$availableConfigs = $helper->getServerConfigurationPrefixes();
62
-		$configID = $input->getArgument('configID');
63
-		if(!in_array($configID, $availableConfigs)) {
64
-			$output->writeln("Invalid configID");
65
-			return;
66
-		}
59
+    protected function execute(InputInterface $input, OutputInterface $output) {
60
+        $helper = new Helper(\OC::$server->getConfig());
61
+        $availableConfigs = $helper->getServerConfigurationPrefixes();
62
+        $configID = $input->getArgument('configID');
63
+        if(!in_array($configID, $availableConfigs)) {
64
+            $output->writeln("Invalid configID");
65
+            return;
66
+        }
67 67
 
68
-		$this->setValue(
69
-			$configID,
70
-			$input->getArgument('configKey'),
71
-			$input->getArgument('configValue')
72
-		);
73
-	}
68
+        $this->setValue(
69
+            $configID,
70
+            $input->getArgument('configKey'),
71
+            $input->getArgument('configValue')
72
+        );
73
+    }
74 74
 
75
-	/**
76
-	 * save the configuration value as provided
77
-	 * @param string $configID
78
-	 * @param string $configKey
79
-	 * @param string $configValue
80
-	 */
81
-	protected function setValue($configID, $key, $value) {
82
-		$configHolder = new Configuration($configID);
83
-		$configHolder->$key = $value;
84
-		$configHolder->saveConfiguration();
85
-	}
75
+    /**
76
+     * save the configuration value as provided
77
+     * @param string $configID
78
+     * @param string $configKey
79
+     * @param string $configValue
80
+     */
81
+    protected function setValue($configID, $key, $value) {
82
+        $configHolder = new Configuration($configID);
83
+        $configHolder->$key = $value;
84
+        $configHolder->saveConfiguration();
85
+    }
86 86
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Command/CreateEmptyConfig.php 1 patch
Indentation   +31 added lines, -31 removed lines patch added patch discarded remove patch
@@ -33,39 +33,39 @@
 block discarded – undo
33 33
 use Symfony\Component\Console\Output\OutputInterface;
34 34
 
35 35
 class CreateEmptyConfig extends Command {
36
-	/** @var \OCA\User_LDAP\Helper */
37
-	protected $helper;
36
+    /** @var \OCA\User_LDAP\Helper */
37
+    protected $helper;
38 38
 
39
-	/**
40
-	 * @param Helper $helper
41
-	 */
42
-	public function __construct(Helper $helper) {
43
-		$this->helper = $helper;
44
-		parent::__construct();
45
-	}
39
+    /**
40
+     * @param Helper $helper
41
+     */
42
+    public function __construct(Helper $helper) {
43
+        $this->helper = $helper;
44
+        parent::__construct();
45
+    }
46 46
 
47
-	protected function configure() {
48
-		$this
49
-			->setName('ldap:create-empty-config')
50
-			->setDescription('creates an empty LDAP configuration')
51
-			->addOption(
52
-				'only-print-prefix',
53
-				'p',
54
-				InputOption::VALUE_NONE,
55
-				'outputs only the prefix'
56
-			)
57
-		;
58
-	}
47
+    protected function configure() {
48
+        $this
49
+            ->setName('ldap:create-empty-config')
50
+            ->setDescription('creates an empty LDAP configuration')
51
+            ->addOption(
52
+                'only-print-prefix',
53
+                'p',
54
+                InputOption::VALUE_NONE,
55
+                'outputs only the prefix'
56
+            )
57
+        ;
58
+    }
59 59
 
60
-	protected function execute(InputInterface $input, OutputInterface $output) {
61
-		$configPrefix = $this->helper->getNextServerConfigurationPrefix();
62
-		$configHolder = new Configuration($configPrefix);
63
-		$configHolder->saveConfiguration();
60
+    protected function execute(InputInterface $input, OutputInterface $output) {
61
+        $configPrefix = $this->helper->getNextServerConfigurationPrefix();
62
+        $configHolder = new Configuration($configPrefix);
63
+        $configHolder->saveConfiguration();
64 64
 
65
-		$prose = '';
66
-		if(!$input->getOption('only-print-prefix')) {
67
-			$prose = 'Created new configuration with configID ';
68
-		}
69
-		$output->writeln($prose . "{$configPrefix}");
70
-	}
65
+        $prose = '';
66
+        if(!$input->getOption('only-print-prefix')) {
67
+            $prose = 'Created new configuration with configID ';
68
+        }
69
+        $output->writeln($prose . "{$configPrefix}");
70
+    }
71 71
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Command/ShowConfig.php 1 patch
Indentation   +67 added lines, -67 removed lines patch added patch discarded remove patch
@@ -35,77 +35,77 @@
 block discarded – undo
35 35
 use OCA\User_LDAP\Configuration;
36 36
 
37 37
 class ShowConfig extends Command {
38
-	/** @var \OCA\User_LDAP\Helper */
39
-	protected $helper;
38
+    /** @var \OCA\User_LDAP\Helper */
39
+    protected $helper;
40 40
 
41
-	/**
42
-	 * @param Helper $helper
43
-	 */
44
-	public function __construct(Helper $helper) {
45
-		$this->helper = $helper;
46
-		parent::__construct();
47
-	}
41
+    /**
42
+     * @param Helper $helper
43
+     */
44
+    public function __construct(Helper $helper) {
45
+        $this->helper = $helper;
46
+        parent::__construct();
47
+    }
48 48
 
49
-	protected function configure() {
50
-		$this
51
-			->setName('ldap:show-config')
52
-			->setDescription('shows the LDAP configuration')
53
-			->addArgument(
54
-					'configID',
55
-					InputArgument::OPTIONAL,
56
-					'will show the configuration of the specified id'
57
-				     )
58
-			->addOption(
59
-					'show-password',
60
-					null,
61
-					InputOption::VALUE_NONE,
62
-					'show ldap bind password'
63
-				     )
64
-		;
65
-	}
49
+    protected function configure() {
50
+        $this
51
+            ->setName('ldap:show-config')
52
+            ->setDescription('shows the LDAP configuration')
53
+            ->addArgument(
54
+                    'configID',
55
+                    InputArgument::OPTIONAL,
56
+                    'will show the configuration of the specified id'
57
+                        )
58
+            ->addOption(
59
+                    'show-password',
60
+                    null,
61
+                    InputOption::VALUE_NONE,
62
+                    'show ldap bind password'
63
+                        )
64
+        ;
65
+    }
66 66
 
67
-	protected function execute(InputInterface $input, OutputInterface $output) {
68
-		$availableConfigs = $this->helper->getServerConfigurationPrefixes();
69
-		$configID = $input->getArgument('configID');
70
-		if(!is_null($configID)) {
71
-			$configIDs[] = $configID;
72
-			if(!in_array($configIDs[0], $availableConfigs)) {
73
-				$output->writeln("Invalid configID");
74
-				return;
75
-			}
76
-		} else {
77
-			$configIDs = $availableConfigs;
78
-		}
67
+    protected function execute(InputInterface $input, OutputInterface $output) {
68
+        $availableConfigs = $this->helper->getServerConfigurationPrefixes();
69
+        $configID = $input->getArgument('configID');
70
+        if(!is_null($configID)) {
71
+            $configIDs[] = $configID;
72
+            if(!in_array($configIDs[0], $availableConfigs)) {
73
+                $output->writeln("Invalid configID");
74
+                return;
75
+            }
76
+        } else {
77
+            $configIDs = $availableConfigs;
78
+        }
79 79
 
80
-		$this->renderConfigs($configIDs, $output, $input->getOption('show-password'));
81
-	}
80
+        $this->renderConfigs($configIDs, $output, $input->getOption('show-password'));
81
+    }
82 82
 
83
-	/**
84
-	 * prints the LDAP configuration(s)
85
-	 * @param string[] configID(s)
86
-	 * @param OutputInterface $output
87
-	 * @param bool $withPassword      Set to TRUE to show plaintext passwords in output
88
-	 */
89
-	protected function renderConfigs($configIDs, $output, $withPassword) {
90
-		foreach($configIDs as $id) {
91
-			$configHolder = new Configuration($id);
92
-			$configuration = $configHolder->getConfiguration();
93
-			ksort($configuration);
83
+    /**
84
+     * prints the LDAP configuration(s)
85
+     * @param string[] configID(s)
86
+     * @param OutputInterface $output
87
+     * @param bool $withPassword      Set to TRUE to show plaintext passwords in output
88
+     */
89
+    protected function renderConfigs($configIDs, $output, $withPassword) {
90
+        foreach($configIDs as $id) {
91
+            $configHolder = new Configuration($id);
92
+            $configuration = $configHolder->getConfiguration();
93
+            ksort($configuration);
94 94
 
95
-			$table = new Table($output);
96
-			$table->setHeaders(array('Configuration', $id));
97
-			$rows = array();
98
-			foreach($configuration as $key => $value) {
99
-				if($key === 'ldapAgentPassword' && !$withPassword) {
100
-					$value = '***';
101
-				}
102
-				if(is_array($value)) {
103
-					$value = implode(';', $value);
104
-				}
105
-				$rows[] = array($key, $value);
106
-			}
107
-			$table->setRows($rows);
108
-			$table->render($output);
109
-		}
110
-	}
95
+            $table = new Table($output);
96
+            $table->setHeaders(array('Configuration', $id));
97
+            $rows = array();
98
+            foreach($configuration as $key => $value) {
99
+                if($key === 'ldapAgentPassword' && !$withPassword) {
100
+                    $value = '***';
101
+                }
102
+                if(is_array($value)) {
103
+                    $value = implode(';', $value);
104
+                }
105
+                $rows[] = array($key, $value);
106
+            }
107
+            $table->setRows($rows);
108
+            $table->render($output);
109
+        }
110
+    }
111 111
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/LDAPUtility.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -26,13 +26,13 @@
 block discarded – undo
26 26
 namespace OCA\User_LDAP;
27 27
 
28 28
 abstract class LDAPUtility {
29
-	protected $ldap;
29
+    protected $ldap;
30 30
 
31
-	/**
32
-	 * constructor, make sure the subclasses call this one!
33
-	 * @param ILDAPWrapper $ldapWrapper an instance of an ILDAPWrapper
34
-	 */
35
-	public function __construct(ILDAPWrapper $ldapWrapper) {
36
-		$this->ldap = $ldapWrapper;
37
-	}
31
+    /**
32
+     * constructor, make sure the subclasses call this one!
33
+     * @param ILDAPWrapper $ldapWrapper an instance of an ILDAPWrapper
34
+     */
35
+    public function __construct(ILDAPWrapper $ldapWrapper) {
36
+        $this->ldap = $ldapWrapper;
37
+    }
38 38
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Settings/Section.php 1 patch
Indentation   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -28,55 +28,55 @@
 block discarded – undo
28 28
 use OCP\Settings\IIconSection;
29 29
 
30 30
 class Section implements IIconSection {
31
-	/** @var IL10N */
32
-	private $l;
33
-	/** @var IURLGenerator */
34
-	private $url;
31
+    /** @var IL10N */
32
+    private $l;
33
+    /** @var IURLGenerator */
34
+    private $url;
35 35
 
36
-	/**
37
-	 * @param IURLGenerator $url
38
-	 * @param IL10N $l
39
-	 */
40
-	public function __construct(IURLGenerator $url, IL10N $l) {
41
-		$this->url = $url;
42
-		$this->l = $l;
43
-	}
36
+    /**
37
+     * @param IURLGenerator $url
38
+     * @param IL10N $l
39
+     */
40
+    public function __construct(IURLGenerator $url, IL10N $l) {
41
+        $this->url = $url;
42
+        $this->l = $l;
43
+    }
44 44
 
45
-	/**
46
-	 * returns the ID of the section. It is supposed to be a lower case string,
47
-	 * e.g. 'ldap'
48
-	 *
49
-	 * @returns string
50
-	 */
51
-	public function getID() {
52
-		return 'ldap';
53
-	}
45
+    /**
46
+     * returns the ID of the section. It is supposed to be a lower case string,
47
+     * e.g. 'ldap'
48
+     *
49
+     * @returns string
50
+     */
51
+    public function getID() {
52
+        return 'ldap';
53
+    }
54 54
 
55
-	/**
56
-	 * returns the translated name as it should be displayed, e.g. 'LDAP / AD
57
-	 * integration'. Use the L10N service to translate it.
58
-	 *
59
-	 * @return string
60
-	 */
61
-	public function getName() {
62
-		return $this->l->t('LDAP / AD integration');
63
-	}
55
+    /**
56
+     * returns the translated name as it should be displayed, e.g. 'LDAP / AD
57
+     * integration'. Use the L10N service to translate it.
58
+     *
59
+     * @return string
60
+     */
61
+    public function getName() {
62
+        return $this->l->t('LDAP / AD integration');
63
+    }
64 64
 
65
-	/**
66
-	 * @return int whether the form should be rather on the top or bottom of
67
-	 * the settings navigation. The sections are arranged in ascending order of
68
-	 * the priority values. It is required to return a value between 0 and 99.
69
-	 *
70
-	 * E.g.: 70
71
-	 */
72
-	public function getPriority() {
73
-		return 25;
74
-	}
65
+    /**
66
+     * @return int whether the form should be rather on the top or bottom of
67
+     * the settings navigation. The sections are arranged in ascending order of
68
+     * the priority values. It is required to return a value between 0 and 99.
69
+     *
70
+     * E.g.: 70
71
+     */
72
+    public function getPriority() {
73
+        return 25;
74
+    }
75 75
 
76
-	/**
77
-	 * {@inheritdoc}
78
-	 */
79
-	public function getIcon() {
80
-		return $this->url->imagePath('user_ldap', 'app-dark.svg');
81
-	}
76
+    /**
77
+     * {@inheritdoc}
78
+     */
79
+    public function getIcon() {
80
+        return $this->url->imagePath('user_ldap', 'app-dark.svg');
81
+    }
82 82
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Settings/Admin.php 1 patch
Indentation   +47 added lines, -47 removed lines patch added patch discarded remove patch
@@ -31,59 +31,59 @@
 block discarded – undo
31 31
 use OCP\Template;
32 32
 
33 33
 class Admin implements ISettings {
34
-	/** @var IL10N */
35
-	private $l;
34
+    /** @var IL10N */
35
+    private $l;
36 36
 
37
-	/**
38
-	 * @param IL10N $l
39
-	 */
40
-	public function __construct(IL10N $l) {
41
-		$this->l = $l;
42
-	}
37
+    /**
38
+     * @param IL10N $l
39
+     */
40
+    public function __construct(IL10N $l) {
41
+        $this->l = $l;
42
+    }
43 43
 
44
-	/**
45
-	 * @return TemplateResponse
46
-	 */
47
-	public function getForm() {
48
-		$helper = new Helper(\OC::$server->getConfig());
49
-		$prefixes = $helper->getServerConfigurationPrefixes();
50
-		$hosts = $helper->getServerConfigurationHosts();
44
+    /**
45
+     * @return TemplateResponse
46
+     */
47
+    public function getForm() {
48
+        $helper = new Helper(\OC::$server->getConfig());
49
+        $prefixes = $helper->getServerConfigurationPrefixes();
50
+        $hosts = $helper->getServerConfigurationHosts();
51 51
 
52
-		$wControls = new Template('user_ldap', 'part.wizardcontrols');
53
-		$wControls = $wControls->fetchPage();
54
-		$sControls = new Template('user_ldap', 'part.settingcontrols');
55
-		$sControls = $sControls->fetchPage();
52
+        $wControls = new Template('user_ldap', 'part.wizardcontrols');
53
+        $wControls = $wControls->fetchPage();
54
+        $sControls = new Template('user_ldap', 'part.settingcontrols');
55
+        $sControls = $sControls->fetchPage();
56 56
 
57
-		$parameters['serverConfigurationPrefixes'] = $prefixes;
58
-		$parameters['serverConfigurationHosts'] = $hosts;
59
-		$parameters['settingControls'] = $sControls;
60
-		$parameters['wizardControls'] = $wControls;
57
+        $parameters['serverConfigurationPrefixes'] = $prefixes;
58
+        $parameters['serverConfigurationHosts'] = $hosts;
59
+        $parameters['settingControls'] = $sControls;
60
+        $parameters['wizardControls'] = $wControls;
61 61
 
62
-		// assign default values
63
-		$config = new Configuration('', false);
64
-		$defaults = $config->getDefaults();
65
-		foreach($defaults as $key => $default) {
66
-			$parameters[$key.'_default'] = $default;
67
-		}
62
+        // assign default values
63
+        $config = new Configuration('', false);
64
+        $defaults = $config->getDefaults();
65
+        foreach($defaults as $key => $default) {
66
+            $parameters[$key.'_default'] = $default;
67
+        }
68 68
 
69
-		return new TemplateResponse('user_ldap', 'settings', $parameters);
70
-	}
69
+        return new TemplateResponse('user_ldap', 'settings', $parameters);
70
+    }
71 71
 
72
-	/**
73
-	 * @return string the section ID, e.g. 'sharing'
74
-	 */
75
-	public function getSection() {
76
-		return 'ldap';
77
-	}
72
+    /**
73
+     * @return string the section ID, e.g. 'sharing'
74
+     */
75
+    public function getSection() {
76
+        return 'ldap';
77
+    }
78 78
 
79
-	/**
80
-	 * @return int whether the form should be rather on the top or bottom of
81
-	 * the admin section. The forms are arranged in ascending order of the
82
-	 * priority values. It is required to return a value between 0 and 100.
83
-	 *
84
-	 * E.g.: 70
85
-	 */
86
-	public function getPriority() {
87
-		return 5;
88
-	}
79
+    /**
80
+     * @return int whether the form should be rather on the top or bottom of
81
+     * the admin section. The forms are arranged in ascending order of the
82
+     * priority values. It is required to return a value between 0 and 100.
83
+     *
84
+     * E.g.: 70
85
+     */
86
+    public function getPriority() {
87
+        return 5;
88
+    }
89 89
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Connection.php 1 patch
Indentation   +564 added lines, -564 removed lines patch added patch discarded remove patch
@@ -51,569 +51,569 @@
 block discarded – undo
51 51
  * @property string ldapUuidGroupAttribute
52 52
  */
53 53
 class Connection extends LDAPUtility {
54
-	private $ldapConnectionRes = null;
55
-	private $configPrefix;
56
-	private $configID;
57
-	private $configured = false;
58
-	private $hasPagedResultSupport = true;
59
-	//whether connection should be kept on __destruct
60
-	private $dontDestruct = false;
61
-
62
-	/**
63
-	 * @var bool runtime flag that indicates whether supported primary groups are available
64
-	 */
65
-	public $hasPrimaryGroups = true;
66
-
67
-	//cache handler
68
-	protected $cache;
69
-
70
-	/** @var Configuration settings handler **/
71
-	protected $configuration;
72
-
73
-	protected $doNotValidate = false;
74
-
75
-	protected $ignoreValidation = false;
76
-
77
-	/**
78
-	 * Constructor
79
-	 * @param ILDAPWrapper $ldap
80
-	 * @param string $configPrefix a string with the prefix for the configkey column (appconfig table)
81
-	 * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections
82
-	 */
83
-	public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') {
84
-		parent::__construct($ldap);
85
-		$this->configPrefix = $configPrefix;
86
-		$this->configID = $configID;
87
-		$this->configuration = new Configuration($configPrefix,
88
-												 !is_null($configID));
89
-		$memcache = \OC::$server->getMemCacheFactory();
90
-		if($memcache->isAvailable()) {
91
-			$this->cache = $memcache->create();
92
-		}
93
-		$helper = new Helper(\OC::$server->getConfig());
94
-		$this->doNotValidate = !in_array($this->configPrefix,
95
-			$helper->getServerConfigurationPrefixes());
96
-		$this->hasPagedResultSupport =
97
-			intval($this->configuration->ldapPagingSize) !== 0
98
-			|| $this->ldap->hasPagedResultSupport();
99
-	}
100
-
101
-	public function __destruct() {
102
-		if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
103
-			@$this->ldap->unbind($this->ldapConnectionRes);
104
-		};
105
-	}
106
-
107
-	/**
108
-	 * defines behaviour when the instance is cloned
109
-	 */
110
-	public function __clone() {
111
-		$this->configuration = new Configuration($this->configPrefix,
112
-												 !is_null($this->configID));
113
-		$this->ldapConnectionRes = null;
114
-		$this->dontDestruct = true;
115
-	}
116
-
117
-	/**
118
-	 * @param string $name
119
-	 * @return bool|mixed|void
120
-	 */
121
-	public function __get($name) {
122
-		if(!$this->configured) {
123
-			$this->readConfiguration();
124
-		}
125
-
126
-		if($name === 'hasPagedResultSupport') {
127
-			return $this->hasPagedResultSupport;
128
-		}
129
-
130
-		return $this->configuration->$name;
131
-	}
132
-
133
-	/**
134
-	 * @param string $name
135
-	 * @param mixed $value
136
-	 */
137
-	public function __set($name, $value) {
138
-		$this->doNotValidate = false;
139
-		$before = $this->configuration->$name;
140
-		$this->configuration->$name = $value;
141
-		$after = $this->configuration->$name;
142
-		if($before !== $after) {
143
-			if ($this->configID !== '') {
144
-				$this->configuration->saveConfiguration();
145
-			}
146
-			$this->validateConfiguration();
147
-		}
148
-	}
149
-
150
-	/**
151
-	 * sets whether the result of the configuration validation shall
152
-	 * be ignored when establishing the connection. Used by the Wizard
153
-	 * in early configuration state.
154
-	 * @param bool $state
155
-	 */
156
-	public function setIgnoreValidation($state) {
157
-		$this->ignoreValidation = (bool)$state;
158
-	}
159
-
160
-	/**
161
-	 * initializes the LDAP backend
162
-	 * @param bool $force read the config settings no matter what
163
-	 */
164
-	public function init($force = false) {
165
-		$this->readConfiguration($force);
166
-		$this->establishConnection();
167
-	}
168
-
169
-	/**
170
-	 * Returns the LDAP handler
171
-	 */
172
-	public function getConnectionResource() {
173
-		if(!$this->ldapConnectionRes) {
174
-			$this->init();
175
-		} else if(!$this->ldap->isResource($this->ldapConnectionRes)) {
176
-			$this->ldapConnectionRes = null;
177
-			$this->establishConnection();
178
-		}
179
-		if(is_null($this->ldapConnectionRes)) {
180
-			\OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, \OCP\Util::ERROR);
181
-			throw new ServerNotAvailableException('Connection to LDAP server could not be established');
182
-		}
183
-		return $this->ldapConnectionRes;
184
-	}
185
-
186
-	/**
187
-	 * resets the connection resource
188
-	 */
189
-	public function resetConnectionResource() {
190
-		if(!is_null($this->ldapConnectionRes)) {
191
-			@$this->ldap->unbind($this->ldapConnectionRes);
192
-			$this->ldapConnectionRes = null;
193
-		}
194
-	}
195
-
196
-	/**
197
-	 * @param string|null $key
198
-	 * @return string
199
-	 */
200
-	private function getCacheKey($key) {
201
-		$prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
202
-		if(is_null($key)) {
203
-			return $prefix;
204
-		}
205
-		return $prefix.md5($key);
206
-	}
207
-
208
-	/**
209
-	 * @param string $key
210
-	 * @return mixed|null
211
-	 */
212
-	public function getFromCache($key) {
213
-		if(!$this->configured) {
214
-			$this->readConfiguration();
215
-		}
216
-		if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
217
-			return null;
218
-		}
219
-		$key = $this->getCacheKey($key);
220
-
221
-		return json_decode(base64_decode($this->cache->get($key)), true);
222
-	}
223
-
224
-	/**
225
-	 * @param string $key
226
-	 * @param mixed $value
227
-	 *
228
-	 * @return string
229
-	 */
230
-	public function writeToCache($key, $value) {
231
-		if(!$this->configured) {
232
-			$this->readConfiguration();
233
-		}
234
-		if(is_null($this->cache)
235
-			|| !$this->configuration->ldapCacheTTL
236
-			|| !$this->configuration->ldapConfigurationActive) {
237
-			return null;
238
-		}
239
-		$key   = $this->getCacheKey($key);
240
-		$value = base64_encode(json_encode($value));
241
-		$this->cache->set($key, $value, $this->configuration->ldapCacheTTL);
242
-	}
243
-
244
-	public function clearCache() {
245
-		if(!is_null($this->cache)) {
246
-			$this->cache->clear($this->getCacheKey(null));
247
-		}
248
-	}
249
-
250
-	/**
251
-	 * Caches the general LDAP configuration.
252
-	 * @param bool $force optional. true, if the re-read should be forced. defaults
253
-	 * to false.
254
-	 * @return null
255
-	 */
256
-	private function readConfiguration($force = false) {
257
-		if((!$this->configured || $force) && !is_null($this->configID)) {
258
-			$this->configuration->readConfiguration();
259
-			$this->configured = $this->validateConfiguration();
260
-		}
261
-	}
262
-
263
-	/**
264
-	 * set LDAP configuration with values delivered by an array, not read from configuration
265
-	 * @param array $config array that holds the config parameters in an associated array
266
-	 * @param array &$setParameters optional; array where the set fields will be given to
267
-	 * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
268
-	 */
269
-	public function setConfiguration($config, &$setParameters = null) {
270
-		if(is_null($setParameters)) {
271
-			$setParameters = array();
272
-		}
273
-		$this->doNotValidate = false;
274
-		$this->configuration->setConfiguration($config, $setParameters);
275
-		if(count($setParameters) > 0) {
276
-			$this->configured = $this->validateConfiguration();
277
-		}
278
-
279
-
280
-		return $this->configured;
281
-	}
282
-
283
-	/**
284
-	 * saves the current Configuration in the database and empties the
285
-	 * cache
286
-	 * @return null
287
-	 */
288
-	public function saveConfiguration() {
289
-		$this->configuration->saveConfiguration();
290
-		$this->clearCache();
291
-	}
292
-
293
-	/**
294
-	 * get the current LDAP configuration
295
-	 * @return array
296
-	 */
297
-	public function getConfiguration() {
298
-		$this->readConfiguration();
299
-		$config = $this->configuration->getConfiguration();
300
-		$cta = $this->configuration->getConfigTranslationArray();
301
-		$result = array();
302
-		foreach($cta as $dbkey => $configkey) {
303
-			switch($configkey) {
304
-				case 'homeFolderNamingRule':
305
-					if(strpos($config[$configkey], 'attr:') === 0) {
306
-						$result[$dbkey] = substr($config[$configkey], 5);
307
-					} else {
308
-						$result[$dbkey] = '';
309
-					}
310
-					break;
311
-				case 'ldapBase':
312
-				case 'ldapBaseUsers':
313
-				case 'ldapBaseGroups':
314
-				case 'ldapAttributesForUserSearch':
315
-				case 'ldapAttributesForGroupSearch':
316
-					if(is_array($config[$configkey])) {
317
-						$result[$dbkey] = implode("\n", $config[$configkey]);
318
-						break;
319
-					} //else follows default
320
-				default:
321
-					$result[$dbkey] = $config[$configkey];
322
-			}
323
-		}
324
-		return $result;
325
-	}
326
-
327
-	private function doSoftValidation() {
328
-		//if User or Group Base are not set, take over Base DN setting
329
-		foreach(array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) {
330
-			$val = $this->configuration->$keyBase;
331
-			if(empty($val)) {
332
-				$this->configuration->$keyBase = $this->configuration->ldapBase;
333
-			}
334
-		}
335
-
336
-		foreach(array('ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
337
-					  'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute')
338
-				as $expertSetting => $effectiveSetting) {
339
-			$uuidOverride = $this->configuration->$expertSetting;
340
-			if(!empty($uuidOverride)) {
341
-				$this->configuration->$effectiveSetting = $uuidOverride;
342
-			} else {
343
-				$uuidAttributes = array('auto', 'entryuuid', 'nsuniqueid',
344
-										'objectguid', 'guid', 'ipauniqueid');
345
-				if(!in_array($this->configuration->$effectiveSetting,
346
-							$uuidAttributes)
347
-					&& (!is_null($this->configID))) {
348
-					$this->configuration->$effectiveSetting = 'auto';
349
-					$this->configuration->saveConfiguration();
350
-					\OCP\Util::writeLog('user_ldap',
351
-										'Illegal value for the '.
352
-										$effectiveSetting.', '.'reset to '.
353
-										'autodetect.', \OCP\Util::INFO);
354
-				}
355
-
356
-			}
357
-		}
358
-
359
-		$backupPort = intval($this->configuration->ldapBackupPort);
360
-		if ($backupPort <= 0) {
361
-			$this->configuration->backupPort = $this->configuration->ldapPort;
362
-		}
363
-
364
-		//make sure empty search attributes are saved as simple, empty array
365
-		$saKeys = array('ldapAttributesForUserSearch',
366
-						'ldapAttributesForGroupSearch');
367
-		foreach($saKeys as $key) {
368
-			$val = $this->configuration->$key;
369
-			if(is_array($val) && count($val) === 1 && empty($val[0])) {
370
-				$this->configuration->$key = array();
371
-			}
372
-		}
373
-
374
-		if((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
375
-			&& $this->configuration->ldapTLS) {
376
-			$this->configuration->ldapTLS = false;
377
-			\OCP\Util::writeLog('user_ldap',
378
-								'LDAPS (already using secure connection) and '.
379
-								'TLS do not work together. Switched off TLS.',
380
-								\OCP\Util::INFO);
381
-		}
382
-	}
383
-
384
-	/**
385
-	 * @return bool
386
-	 */
387
-	private function doCriticalValidation() {
388
-		$configurationOK = true;
389
-		$errorStr = 'Configuration Error (prefix '.
390
-					strval($this->configPrefix).'): ';
391
-
392
-		//options that shall not be empty
393
-		$options = array('ldapHost', 'ldapPort', 'ldapUserDisplayName',
394
-						 'ldapGroupDisplayName', 'ldapLoginFilter');
395
-		foreach($options as $key) {
396
-			$val = $this->configuration->$key;
397
-			if(empty($val)) {
398
-				switch($key) {
399
-					case 'ldapHost':
400
-						$subj = 'LDAP Host';
401
-						break;
402
-					case 'ldapPort':
403
-						$subj = 'LDAP Port';
404
-						break;
405
-					case 'ldapUserDisplayName':
406
-						$subj = 'LDAP User Display Name';
407
-						break;
408
-					case 'ldapGroupDisplayName':
409
-						$subj = 'LDAP Group Display Name';
410
-						break;
411
-					case 'ldapLoginFilter':
412
-						$subj = 'LDAP Login Filter';
413
-						break;
414
-					default:
415
-						$subj = $key;
416
-						break;
417
-				}
418
-				$configurationOK = false;
419
-				\OCP\Util::writeLog('user_ldap',
420
-									$errorStr.'No '.$subj.' given!',
421
-									\OCP\Util::WARN);
422
-			}
423
-		}
424
-
425
-		//combinations
426
-		$agent = $this->configuration->ldapAgentName;
427
-		$pwd = $this->configuration->ldapAgentPassword;
428
-		if (
429
-			($agent === ''  && $pwd !== '')
430
-			|| ($agent !== '' && $pwd === '')
431
-		) {
432
-			\OCP\Util::writeLog('user_ldap',
433
-								$errorStr.'either no password is given for the'.
434
-								'user agent or a password is given, but not an'.
435
-								'LDAP agent.',
436
-				\OCP\Util::WARN);
437
-			$configurationOK = false;
438
-		}
439
-
440
-		$base = $this->configuration->ldapBase;
441
-		$baseUsers = $this->configuration->ldapBaseUsers;
442
-		$baseGroups = $this->configuration->ldapBaseGroups;
443
-
444
-		if(empty($base) && empty($baseUsers) && empty($baseGroups)) {
445
-			\OCP\Util::writeLog('user_ldap',
446
-								$errorStr.'Not a single Base DN given.',
447
-								\OCP\Util::WARN);
448
-			$configurationOK = false;
449
-		}
450
-
451
-		if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
452
-		   === false) {
453
-			\OCP\Util::writeLog('user_ldap',
454
-								$errorStr.'login filter does not contain %uid '.
455
-								'place holder.',
456
-								\OCP\Util::WARN);
457
-			$configurationOK = false;
458
-		}
459
-
460
-		return $configurationOK;
461
-	}
462
-
463
-	/**
464
-	 * Validates the user specified configuration
465
-	 * @return bool true if configuration seems OK, false otherwise
466
-	 */
467
-	private function validateConfiguration() {
468
-
469
-		if($this->doNotValidate) {
470
-			//don't do a validation if it is a new configuration with pure
471
-			//default values. Will be allowed on changes via __set or
472
-			//setConfiguration
473
-			return false;
474
-		}
475
-
476
-		// first step: "soft" checks: settings that are not really
477
-		// necessary, but advisable. If left empty, give an info message
478
-		$this->doSoftValidation();
479
-
480
-		//second step: critical checks. If left empty or filled wrong, mark as
481
-		//not configured and give a warning.
482
-		return $this->doCriticalValidation();
483
-	}
484
-
485
-
486
-	/**
487
-	 * Connects and Binds to LDAP
488
-	 */
489
-	private function establishConnection() {
490
-		if(!$this->configuration->ldapConfigurationActive) {
491
-			return null;
492
-		}
493
-		static $phpLDAPinstalled = true;
494
-		if(!$phpLDAPinstalled) {
495
-			return false;
496
-		}
497
-		if(!$this->ignoreValidation && !$this->configured) {
498
-			\OCP\Util::writeLog('user_ldap',
499
-								'Configuration is invalid, cannot connect',
500
-								\OCP\Util::WARN);
501
-			return false;
502
-		}
503
-		if(!$this->ldapConnectionRes) {
504
-			if(!$this->ldap->areLDAPFunctionsAvailable()) {
505
-				$phpLDAPinstalled = false;
506
-				\OCP\Util::writeLog('user_ldap',
507
-									'function ldap_connect is not available. Make '.
508
-									'sure that the PHP ldap module is installed.',
509
-									\OCP\Util::ERROR);
510
-
511
-				return false;
512
-			}
513
-			if($this->configuration->turnOffCertCheck) {
514
-				if(putenv('LDAPTLS_REQCERT=never')) {
515
-					\OCP\Util::writeLog('user_ldap',
516
-						'Turned off SSL certificate validation successfully.',
517
-						\OCP\Util::DEBUG);
518
-				} else {
519
-					\OCP\Util::writeLog('user_ldap',
520
-										'Could not turn off SSL certificate validation.',
521
-										\OCP\Util::WARN);
522
-				}
523
-			}
524
-
525
-			$bindStatus = false;
526
-			$error = -1;
527
-			try {
528
-				if (!$this->configuration->ldapOverrideMainServer
529
-					&& !$this->getFromCache('overrideMainServer')
530
-				) {
531
-					$this->doConnect($this->configuration->ldapHost,
532
-						$this->configuration->ldapPort);
533
-					$bindStatus = $this->bind();
534
-					$error = $this->ldap->isResource($this->ldapConnectionRes) ?
535
-						$this->ldap->errno($this->ldapConnectionRes) : -1;
536
-				}
537
-				if($bindStatus === true) {
538
-					return $bindStatus;
539
-				}
540
-			} catch (\OC\ServerNotAvailableException $e) {
541
-				if(trim($this->configuration->ldapBackupHost) === "") {
542
-					throw $e;
543
-				}
544
-			}
545
-
546
-			//if LDAP server is not reachable, try the Backup (Replica!) Server
547
-			if(    $error !== 0
548
-				|| $this->configuration->ldapOverrideMainServer
549
-				|| $this->getFromCache('overrideMainServer'))
550
-			{
551
-				$this->doConnect($this->configuration->ldapBackupHost,
552
-								 $this->configuration->ldapBackupPort);
553
-				$bindStatus = $this->bind();
554
-				if($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) {
555
-					//when bind to backup server succeeded and failed to main server,
556
-					//skip contacting him until next cache refresh
557
-					$this->writeToCache('overrideMainServer', true);
558
-				}
559
-			}
560
-			return $bindStatus;
561
-		}
562
-		return null;
563
-	}
564
-
565
-	/**
566
-	 * @param string $host
567
-	 * @param string $port
568
-	 * @return bool
569
-	 * @throws \OC\ServerNotAvailableException
570
-	 */
571
-	private function doConnect($host, $port) {
572
-		if ($host === '') {
573
-			return false;
574
-		}
575
-		$this->ldapConnectionRes = $this->ldap->connect($host, $port);
576
-		if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
577
-			if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
578
-				if($this->configuration->ldapTLS) {
579
-					$this->ldap->startTls($this->ldapConnectionRes);
580
-				}
581
-			}
582
-		} else {
583
-			throw new \OC\ServerNotAvailableException('Could not set required LDAP Protocol version.');
584
-		}
585
-		return true;
586
-	}
587
-
588
-	/**
589
-	 * Binds to LDAP
590
-	 */
591
-	public function bind() {
592
-		static $getConnectionResourceAttempt = false;
593
-		if(!$this->configuration->ldapConfigurationActive) {
594
-			return false;
595
-		}
596
-		if($getConnectionResourceAttempt) {
597
-			$getConnectionResourceAttempt = false;
598
-			return false;
599
-		}
600
-		$getConnectionResourceAttempt = true;
601
-		$cr = $this->getConnectionResource();
602
-		$getConnectionResourceAttempt = false;
603
-		if(!$this->ldap->isResource($cr)) {
604
-			return false;
605
-		}
606
-		$ldapLogin = @$this->ldap->bind($cr,
607
-										$this->configuration->ldapAgentName,
608
-										$this->configuration->ldapAgentPassword);
609
-		if(!$ldapLogin) {
610
-			\OCP\Util::writeLog('user_ldap',
611
-				'Bind failed: ' . $this->ldap->errno($cr) . ': ' . $this->ldap->error($cr),
612
-				\OCP\Util::WARN);
613
-			$this->ldapConnectionRes = null;
614
-			return false;
615
-		}
616
-		return true;
617
-	}
54
+    private $ldapConnectionRes = null;
55
+    private $configPrefix;
56
+    private $configID;
57
+    private $configured = false;
58
+    private $hasPagedResultSupport = true;
59
+    //whether connection should be kept on __destruct
60
+    private $dontDestruct = false;
61
+
62
+    /**
63
+     * @var bool runtime flag that indicates whether supported primary groups are available
64
+     */
65
+    public $hasPrimaryGroups = true;
66
+
67
+    //cache handler
68
+    protected $cache;
69
+
70
+    /** @var Configuration settings handler **/
71
+    protected $configuration;
72
+
73
+    protected $doNotValidate = false;
74
+
75
+    protected $ignoreValidation = false;
76
+
77
+    /**
78
+     * Constructor
79
+     * @param ILDAPWrapper $ldap
80
+     * @param string $configPrefix a string with the prefix for the configkey column (appconfig table)
81
+     * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections
82
+     */
83
+    public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') {
84
+        parent::__construct($ldap);
85
+        $this->configPrefix = $configPrefix;
86
+        $this->configID = $configID;
87
+        $this->configuration = new Configuration($configPrefix,
88
+                                                    !is_null($configID));
89
+        $memcache = \OC::$server->getMemCacheFactory();
90
+        if($memcache->isAvailable()) {
91
+            $this->cache = $memcache->create();
92
+        }
93
+        $helper = new Helper(\OC::$server->getConfig());
94
+        $this->doNotValidate = !in_array($this->configPrefix,
95
+            $helper->getServerConfigurationPrefixes());
96
+        $this->hasPagedResultSupport =
97
+            intval($this->configuration->ldapPagingSize) !== 0
98
+            || $this->ldap->hasPagedResultSupport();
99
+    }
100
+
101
+    public function __destruct() {
102
+        if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
103
+            @$this->ldap->unbind($this->ldapConnectionRes);
104
+        };
105
+    }
106
+
107
+    /**
108
+     * defines behaviour when the instance is cloned
109
+     */
110
+    public function __clone() {
111
+        $this->configuration = new Configuration($this->configPrefix,
112
+                                                    !is_null($this->configID));
113
+        $this->ldapConnectionRes = null;
114
+        $this->dontDestruct = true;
115
+    }
116
+
117
+    /**
118
+     * @param string $name
119
+     * @return bool|mixed|void
120
+     */
121
+    public function __get($name) {
122
+        if(!$this->configured) {
123
+            $this->readConfiguration();
124
+        }
125
+
126
+        if($name === 'hasPagedResultSupport') {
127
+            return $this->hasPagedResultSupport;
128
+        }
129
+
130
+        return $this->configuration->$name;
131
+    }
132
+
133
+    /**
134
+     * @param string $name
135
+     * @param mixed $value
136
+     */
137
+    public function __set($name, $value) {
138
+        $this->doNotValidate = false;
139
+        $before = $this->configuration->$name;
140
+        $this->configuration->$name = $value;
141
+        $after = $this->configuration->$name;
142
+        if($before !== $after) {
143
+            if ($this->configID !== '') {
144
+                $this->configuration->saveConfiguration();
145
+            }
146
+            $this->validateConfiguration();
147
+        }
148
+    }
149
+
150
+    /**
151
+     * sets whether the result of the configuration validation shall
152
+     * be ignored when establishing the connection. Used by the Wizard
153
+     * in early configuration state.
154
+     * @param bool $state
155
+     */
156
+    public function setIgnoreValidation($state) {
157
+        $this->ignoreValidation = (bool)$state;
158
+    }
159
+
160
+    /**
161
+     * initializes the LDAP backend
162
+     * @param bool $force read the config settings no matter what
163
+     */
164
+    public function init($force = false) {
165
+        $this->readConfiguration($force);
166
+        $this->establishConnection();
167
+    }
168
+
169
+    /**
170
+     * Returns the LDAP handler
171
+     */
172
+    public function getConnectionResource() {
173
+        if(!$this->ldapConnectionRes) {
174
+            $this->init();
175
+        } else if(!$this->ldap->isResource($this->ldapConnectionRes)) {
176
+            $this->ldapConnectionRes = null;
177
+            $this->establishConnection();
178
+        }
179
+        if(is_null($this->ldapConnectionRes)) {
180
+            \OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, \OCP\Util::ERROR);
181
+            throw new ServerNotAvailableException('Connection to LDAP server could not be established');
182
+        }
183
+        return $this->ldapConnectionRes;
184
+    }
185
+
186
+    /**
187
+     * resets the connection resource
188
+     */
189
+    public function resetConnectionResource() {
190
+        if(!is_null($this->ldapConnectionRes)) {
191
+            @$this->ldap->unbind($this->ldapConnectionRes);
192
+            $this->ldapConnectionRes = null;
193
+        }
194
+    }
195
+
196
+    /**
197
+     * @param string|null $key
198
+     * @return string
199
+     */
200
+    private function getCacheKey($key) {
201
+        $prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
202
+        if(is_null($key)) {
203
+            return $prefix;
204
+        }
205
+        return $prefix.md5($key);
206
+    }
207
+
208
+    /**
209
+     * @param string $key
210
+     * @return mixed|null
211
+     */
212
+    public function getFromCache($key) {
213
+        if(!$this->configured) {
214
+            $this->readConfiguration();
215
+        }
216
+        if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
217
+            return null;
218
+        }
219
+        $key = $this->getCacheKey($key);
220
+
221
+        return json_decode(base64_decode($this->cache->get($key)), true);
222
+    }
223
+
224
+    /**
225
+     * @param string $key
226
+     * @param mixed $value
227
+     *
228
+     * @return string
229
+     */
230
+    public function writeToCache($key, $value) {
231
+        if(!$this->configured) {
232
+            $this->readConfiguration();
233
+        }
234
+        if(is_null($this->cache)
235
+            || !$this->configuration->ldapCacheTTL
236
+            || !$this->configuration->ldapConfigurationActive) {
237
+            return null;
238
+        }
239
+        $key   = $this->getCacheKey($key);
240
+        $value = base64_encode(json_encode($value));
241
+        $this->cache->set($key, $value, $this->configuration->ldapCacheTTL);
242
+    }
243
+
244
+    public function clearCache() {
245
+        if(!is_null($this->cache)) {
246
+            $this->cache->clear($this->getCacheKey(null));
247
+        }
248
+    }
249
+
250
+    /**
251
+     * Caches the general LDAP configuration.
252
+     * @param bool $force optional. true, if the re-read should be forced. defaults
253
+     * to false.
254
+     * @return null
255
+     */
256
+    private function readConfiguration($force = false) {
257
+        if((!$this->configured || $force) && !is_null($this->configID)) {
258
+            $this->configuration->readConfiguration();
259
+            $this->configured = $this->validateConfiguration();
260
+        }
261
+    }
262
+
263
+    /**
264
+     * set LDAP configuration with values delivered by an array, not read from configuration
265
+     * @param array $config array that holds the config parameters in an associated array
266
+     * @param array &$setParameters optional; array where the set fields will be given to
267
+     * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
268
+     */
269
+    public function setConfiguration($config, &$setParameters = null) {
270
+        if(is_null($setParameters)) {
271
+            $setParameters = array();
272
+        }
273
+        $this->doNotValidate = false;
274
+        $this->configuration->setConfiguration($config, $setParameters);
275
+        if(count($setParameters) > 0) {
276
+            $this->configured = $this->validateConfiguration();
277
+        }
278
+
279
+
280
+        return $this->configured;
281
+    }
282
+
283
+    /**
284
+     * saves the current Configuration in the database and empties the
285
+     * cache
286
+     * @return null
287
+     */
288
+    public function saveConfiguration() {
289
+        $this->configuration->saveConfiguration();
290
+        $this->clearCache();
291
+    }
292
+
293
+    /**
294
+     * get the current LDAP configuration
295
+     * @return array
296
+     */
297
+    public function getConfiguration() {
298
+        $this->readConfiguration();
299
+        $config = $this->configuration->getConfiguration();
300
+        $cta = $this->configuration->getConfigTranslationArray();
301
+        $result = array();
302
+        foreach($cta as $dbkey => $configkey) {
303
+            switch($configkey) {
304
+                case 'homeFolderNamingRule':
305
+                    if(strpos($config[$configkey], 'attr:') === 0) {
306
+                        $result[$dbkey] = substr($config[$configkey], 5);
307
+                    } else {
308
+                        $result[$dbkey] = '';
309
+                    }
310
+                    break;
311
+                case 'ldapBase':
312
+                case 'ldapBaseUsers':
313
+                case 'ldapBaseGroups':
314
+                case 'ldapAttributesForUserSearch':
315
+                case 'ldapAttributesForGroupSearch':
316
+                    if(is_array($config[$configkey])) {
317
+                        $result[$dbkey] = implode("\n", $config[$configkey]);
318
+                        break;
319
+                    } //else follows default
320
+                default:
321
+                    $result[$dbkey] = $config[$configkey];
322
+            }
323
+        }
324
+        return $result;
325
+    }
326
+
327
+    private function doSoftValidation() {
328
+        //if User or Group Base are not set, take over Base DN setting
329
+        foreach(array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) {
330
+            $val = $this->configuration->$keyBase;
331
+            if(empty($val)) {
332
+                $this->configuration->$keyBase = $this->configuration->ldapBase;
333
+            }
334
+        }
335
+
336
+        foreach(array('ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
337
+                        'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute')
338
+                as $expertSetting => $effectiveSetting) {
339
+            $uuidOverride = $this->configuration->$expertSetting;
340
+            if(!empty($uuidOverride)) {
341
+                $this->configuration->$effectiveSetting = $uuidOverride;
342
+            } else {
343
+                $uuidAttributes = array('auto', 'entryuuid', 'nsuniqueid',
344
+                                        'objectguid', 'guid', 'ipauniqueid');
345
+                if(!in_array($this->configuration->$effectiveSetting,
346
+                            $uuidAttributes)
347
+                    && (!is_null($this->configID))) {
348
+                    $this->configuration->$effectiveSetting = 'auto';
349
+                    $this->configuration->saveConfiguration();
350
+                    \OCP\Util::writeLog('user_ldap',
351
+                                        'Illegal value for the '.
352
+                                        $effectiveSetting.', '.'reset to '.
353
+                                        'autodetect.', \OCP\Util::INFO);
354
+                }
355
+
356
+            }
357
+        }
358
+
359
+        $backupPort = intval($this->configuration->ldapBackupPort);
360
+        if ($backupPort <= 0) {
361
+            $this->configuration->backupPort = $this->configuration->ldapPort;
362
+        }
363
+
364
+        //make sure empty search attributes are saved as simple, empty array
365
+        $saKeys = array('ldapAttributesForUserSearch',
366
+                        'ldapAttributesForGroupSearch');
367
+        foreach($saKeys as $key) {
368
+            $val = $this->configuration->$key;
369
+            if(is_array($val) && count($val) === 1 && empty($val[0])) {
370
+                $this->configuration->$key = array();
371
+            }
372
+        }
373
+
374
+        if((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
375
+            && $this->configuration->ldapTLS) {
376
+            $this->configuration->ldapTLS = false;
377
+            \OCP\Util::writeLog('user_ldap',
378
+                                'LDAPS (already using secure connection) and '.
379
+                                'TLS do not work together. Switched off TLS.',
380
+                                \OCP\Util::INFO);
381
+        }
382
+    }
383
+
384
+    /**
385
+     * @return bool
386
+     */
387
+    private function doCriticalValidation() {
388
+        $configurationOK = true;
389
+        $errorStr = 'Configuration Error (prefix '.
390
+                    strval($this->configPrefix).'): ';
391
+
392
+        //options that shall not be empty
393
+        $options = array('ldapHost', 'ldapPort', 'ldapUserDisplayName',
394
+                            'ldapGroupDisplayName', 'ldapLoginFilter');
395
+        foreach($options as $key) {
396
+            $val = $this->configuration->$key;
397
+            if(empty($val)) {
398
+                switch($key) {
399
+                    case 'ldapHost':
400
+                        $subj = 'LDAP Host';
401
+                        break;
402
+                    case 'ldapPort':
403
+                        $subj = 'LDAP Port';
404
+                        break;
405
+                    case 'ldapUserDisplayName':
406
+                        $subj = 'LDAP User Display Name';
407
+                        break;
408
+                    case 'ldapGroupDisplayName':
409
+                        $subj = 'LDAP Group Display Name';
410
+                        break;
411
+                    case 'ldapLoginFilter':
412
+                        $subj = 'LDAP Login Filter';
413
+                        break;
414
+                    default:
415
+                        $subj = $key;
416
+                        break;
417
+                }
418
+                $configurationOK = false;
419
+                \OCP\Util::writeLog('user_ldap',
420
+                                    $errorStr.'No '.$subj.' given!',
421
+                                    \OCP\Util::WARN);
422
+            }
423
+        }
424
+
425
+        //combinations
426
+        $agent = $this->configuration->ldapAgentName;
427
+        $pwd = $this->configuration->ldapAgentPassword;
428
+        if (
429
+            ($agent === ''  && $pwd !== '')
430
+            || ($agent !== '' && $pwd === '')
431
+        ) {
432
+            \OCP\Util::writeLog('user_ldap',
433
+                                $errorStr.'either no password is given for the'.
434
+                                'user agent or a password is given, but not an'.
435
+                                'LDAP agent.',
436
+                \OCP\Util::WARN);
437
+            $configurationOK = false;
438
+        }
439
+
440
+        $base = $this->configuration->ldapBase;
441
+        $baseUsers = $this->configuration->ldapBaseUsers;
442
+        $baseGroups = $this->configuration->ldapBaseGroups;
443
+
444
+        if(empty($base) && empty($baseUsers) && empty($baseGroups)) {
445
+            \OCP\Util::writeLog('user_ldap',
446
+                                $errorStr.'Not a single Base DN given.',
447
+                                \OCP\Util::WARN);
448
+            $configurationOK = false;
449
+        }
450
+
451
+        if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
452
+            === false) {
453
+            \OCP\Util::writeLog('user_ldap',
454
+                                $errorStr.'login filter does not contain %uid '.
455
+                                'place holder.',
456
+                                \OCP\Util::WARN);
457
+            $configurationOK = false;
458
+        }
459
+
460
+        return $configurationOK;
461
+    }
462
+
463
+    /**
464
+     * Validates the user specified configuration
465
+     * @return bool true if configuration seems OK, false otherwise
466
+     */
467
+    private function validateConfiguration() {
468
+
469
+        if($this->doNotValidate) {
470
+            //don't do a validation if it is a new configuration with pure
471
+            //default values. Will be allowed on changes via __set or
472
+            //setConfiguration
473
+            return false;
474
+        }
475
+
476
+        // first step: "soft" checks: settings that are not really
477
+        // necessary, but advisable. If left empty, give an info message
478
+        $this->doSoftValidation();
479
+
480
+        //second step: critical checks. If left empty or filled wrong, mark as
481
+        //not configured and give a warning.
482
+        return $this->doCriticalValidation();
483
+    }
484
+
485
+
486
+    /**
487
+     * Connects and Binds to LDAP
488
+     */
489
+    private function establishConnection() {
490
+        if(!$this->configuration->ldapConfigurationActive) {
491
+            return null;
492
+        }
493
+        static $phpLDAPinstalled = true;
494
+        if(!$phpLDAPinstalled) {
495
+            return false;
496
+        }
497
+        if(!$this->ignoreValidation && !$this->configured) {
498
+            \OCP\Util::writeLog('user_ldap',
499
+                                'Configuration is invalid, cannot connect',
500
+                                \OCP\Util::WARN);
501
+            return false;
502
+        }
503
+        if(!$this->ldapConnectionRes) {
504
+            if(!$this->ldap->areLDAPFunctionsAvailable()) {
505
+                $phpLDAPinstalled = false;
506
+                \OCP\Util::writeLog('user_ldap',
507
+                                    'function ldap_connect is not available. Make '.
508
+                                    'sure that the PHP ldap module is installed.',
509
+                                    \OCP\Util::ERROR);
510
+
511
+                return false;
512
+            }
513
+            if($this->configuration->turnOffCertCheck) {
514
+                if(putenv('LDAPTLS_REQCERT=never')) {
515
+                    \OCP\Util::writeLog('user_ldap',
516
+                        'Turned off SSL certificate validation successfully.',
517
+                        \OCP\Util::DEBUG);
518
+                } else {
519
+                    \OCP\Util::writeLog('user_ldap',
520
+                                        'Could not turn off SSL certificate validation.',
521
+                                        \OCP\Util::WARN);
522
+                }
523
+            }
524
+
525
+            $bindStatus = false;
526
+            $error = -1;
527
+            try {
528
+                if (!$this->configuration->ldapOverrideMainServer
529
+                    && !$this->getFromCache('overrideMainServer')
530
+                ) {
531
+                    $this->doConnect($this->configuration->ldapHost,
532
+                        $this->configuration->ldapPort);
533
+                    $bindStatus = $this->bind();
534
+                    $error = $this->ldap->isResource($this->ldapConnectionRes) ?
535
+                        $this->ldap->errno($this->ldapConnectionRes) : -1;
536
+                }
537
+                if($bindStatus === true) {
538
+                    return $bindStatus;
539
+                }
540
+            } catch (\OC\ServerNotAvailableException $e) {
541
+                if(trim($this->configuration->ldapBackupHost) === "") {
542
+                    throw $e;
543
+                }
544
+            }
545
+
546
+            //if LDAP server is not reachable, try the Backup (Replica!) Server
547
+            if(    $error !== 0
548
+                || $this->configuration->ldapOverrideMainServer
549
+                || $this->getFromCache('overrideMainServer'))
550
+            {
551
+                $this->doConnect($this->configuration->ldapBackupHost,
552
+                                    $this->configuration->ldapBackupPort);
553
+                $bindStatus = $this->bind();
554
+                if($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) {
555
+                    //when bind to backup server succeeded and failed to main server,
556
+                    //skip contacting him until next cache refresh
557
+                    $this->writeToCache('overrideMainServer', true);
558
+                }
559
+            }
560
+            return $bindStatus;
561
+        }
562
+        return null;
563
+    }
564
+
565
+    /**
566
+     * @param string $host
567
+     * @param string $port
568
+     * @return bool
569
+     * @throws \OC\ServerNotAvailableException
570
+     */
571
+    private function doConnect($host, $port) {
572
+        if ($host === '') {
573
+            return false;
574
+        }
575
+        $this->ldapConnectionRes = $this->ldap->connect($host, $port);
576
+        if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
577
+            if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
578
+                if($this->configuration->ldapTLS) {
579
+                    $this->ldap->startTls($this->ldapConnectionRes);
580
+                }
581
+            }
582
+        } else {
583
+            throw new \OC\ServerNotAvailableException('Could not set required LDAP Protocol version.');
584
+        }
585
+        return true;
586
+    }
587
+
588
+    /**
589
+     * Binds to LDAP
590
+     */
591
+    public function bind() {
592
+        static $getConnectionResourceAttempt = false;
593
+        if(!$this->configuration->ldapConfigurationActive) {
594
+            return false;
595
+        }
596
+        if($getConnectionResourceAttempt) {
597
+            $getConnectionResourceAttempt = false;
598
+            return false;
599
+        }
600
+        $getConnectionResourceAttempt = true;
601
+        $cr = $this->getConnectionResource();
602
+        $getConnectionResourceAttempt = false;
603
+        if(!$this->ldap->isResource($cr)) {
604
+            return false;
605
+        }
606
+        $ldapLogin = @$this->ldap->bind($cr,
607
+                                        $this->configuration->ldapAgentName,
608
+                                        $this->configuration->ldapAgentPassword);
609
+        if(!$ldapLogin) {
610
+            \OCP\Util::writeLog('user_ldap',
611
+                'Bind failed: ' . $this->ldap->errno($cr) . ': ' . $this->ldap->error($cr),
612
+                \OCP\Util::WARN);
613
+            $this->ldapConnectionRes = null;
614
+            return false;
615
+        }
616
+        return true;
617
+    }
618 618
 
619 619
 }
Please login to merge, or discard this patch.