xref: /plugin/oauth/helper.php (revision ebf681d1246bca9560103c6ac7c327d113b4ee69) 
1<?php
2/**
3 * DokuWiki Plugin oauth (Helper Component)
4 *
5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6 * @author  Andreas Gohr <andi@splitbrain.org>
7 */
8
9// must be run within Dokuwiki
10if(!defined('DOKU_INC')) die();
11
12class helper_plugin_oauth extends DokuWiki_Plugin {
13
14    /**
15     * Load the needed libraries and initialize the named oAuth service
16     *
17     * @param string $servicename
18     * @return null|\OAuth\Plugin\AbstractAdapter
19     */
20    public function loadService(&$servicename) {
21        $id = getID(); // $ID isn't set in trustExternal, yet
22
23        $servicename = preg_replace('/[^a-zA-Z_]+/', '', $servicename);
24        if(!$servicename) return null;
25
26        require_once(__DIR__.'/phpoauthlib/src/OAuth/bootstrap.php');
27        require_once(__DIR__.'/classes/AbstractAdapter.php');
28        require_once(__DIR__.'/classes/oAuthHTTPClient.php');
29        require_once(__DIR__.'/classes/oAuthStorage.php');
30
31        $file = __DIR__.'/classes/'.$servicename.'Adapter.php';
32        if(!file_exists($file)) return null;
33        require_once($file);
34        $class = '\\OAuth\\Plugin\\'.$servicename.'Adapter';
35
36        /** @var \OAuth\Plugin\AbstractAdapter $service */
37        $service = new $class($this->redirectURI());
38        if(!$service->isInitialized()) {
39            msg("Failed to initialize $service authentication service. Check credentials", -1);
40            return null;
41        }
42
43        // The generic service can be externally configured
44        if(is_a($service->oAuth, 'OAuth\\OAuth2\\Service\\Generic')) {
45            $service->oAuth->setAuthorizationEndpoint($this->getAuthEndpoint($servicename));
46            $service->oAuth->setAccessTokenEndpoint($this->getTokenEndpoint($servicename));
47        }
48
49        return $service;
50    }
51
52    /**
53     * The redirect URI used in all oAuth requests
54     *
55     * @return string
56     */
57    public function redirectURI() {
58        if ($this->getConf('custom-redirectURI') !== '') {
59            return $this->getConf('custom-redirectURI');
60        } else {
61            return DOKU_URL . DOKU_SCRIPT;
62        }
63    }
64
65    /**
66     * List available Services
67     *
68     * @param bool $enabledonly list only enabled services
69     * @return array
70     */
71    public function listServices($enabledonly = true) {
72        $services = array();
73        $files    = glob(__DIR__.'/classes/*Adapter.php');
74
75        foreach($files as $file) {
76            $file = basename($file, 'Adapter.php');
77            if($file == 'Abstract') continue;
78            if($enabledonly && !$this->getKey($file)) continue;
79            $services[] = $file;
80        }
81
82        return $services;
83    }
84
85    /**
86     * Return the configured key for the given service
87     *
88     * @param $service
89     * @return string
90     */
91    public function getKey($service) {
92        $service = strtolower($service);
93        return $this->getConf($service.'-key');
94    }
95
96    /**
97     * Return the configured secret for the given service
98     *
99     * @param $service
100     * @return string
101     */
102    public function getSecret($service) {
103        $service = strtolower($service);
104        return $this->getConf($service.'-secret');
105    }
106
107    /**
108     * Return the configured Authentication Endpoint URL for the given service
109     *
110     * @param $service
111     * @return string
112     */
113    public function getAuthEndpoint($service) {
114        $service = strtolower($service);
115        return $this->getConf($service.'-authurl');
116    }
117
118    /**
119     * Return the configured Access Token Endpoint URL for the given service
120     *
121     * @param $service
122     * @return string
123     */
124    public function getTokenEndpoint($service) {
125        $service = strtolower($service);
126        return $this->getConf($service.'-tokenurl');
127    }
128
129    /**
130     * @return array
131     */
132    public function getValidDomains() {
133        $validDomains = explode(',', trim($this->getConf('mailRestriction'), ','));
134        $validDomains = array_map('trim', $validDomains);
135        return $validDomains;
136    }
137
138    /**
139     * @param string $mail
140     *
141     * @return bool
142     */
143    public function checkMail($mail) {
144        $hostedDomains = $this->getValidDomains();
145
146        foreach ($hostedDomains as $validDomain) {
147            if(substr($mail, -strlen($validDomain)) === $validDomain) {
148                return true;
149            }
150        }
151        return false;
152    }
153}
154
155// vim:ts=4:sw=4:et:
156