warn about remote fork config in setup and help
[phorkie.git] / src / phorkie / SetupCheck.php
1 <?php
2 namespace phorkie;
3
4 class SetupCheck
5 {
6     protected $deps = array(
7         'pear.php.net/VersionControl_Git'  => 'VersionControl_Git',
8         'pear.twig-project.org/Twig'       => 'Twig_Autoloader',
9         'pear.php.net/Date_HumanDiff'      => 'Date_HumanDiff',
10         'pear.php.net/HTTP_Request2'       => 'HTTP_Request2',
11         'pear.php.net/OpenID'              => 'OpenID',
12         'pear.php.net/Pager'               => 'Pager',
13         'pear.php.net/Services_Libravatar' => 'Services_Libravatar',
14         'pear2.php.net/PEAR2_Services_Linkback'  => '\\PEAR2\\Services\\Linkback\\Client',
15         'zustellzentrum.cweiske.de/MIME_Type_PlainDetect' => 'MIME_Type_PlainDetect',
16     );
17
18     protected $writableDirs;
19     protected $elasticsearch;
20
21     public $messages = array();
22
23     public function __construct()
24     {
25         $cfg = $GLOBALS['phorkie']['cfg'];
26         $this->writableDirs = array(
27             'gitdir' => $cfg['gitdir'],
28             'workdir' => $cfg['workdir'],
29         );
30         $this->elasticsearch = $cfg['elasticsearch'];
31     }
32
33     public static function run()
34     {
35         $sc = new self();
36         $sc->checkConfigFiles();
37         $sc->checkDeps();
38         $sc->checkDirs();
39         $sc->checkGit();
40         $sc->checkDatabase();
41         $sc->checkMimeTypeDetection();
42         $sc->checkRemoteForking();
43
44         return $sc->messages;
45     }
46
47     public function checkConfigFiles()
48     {
49         foreach ($GLOBALS['phorkie']['cfgfiles'] as $file => $loaded) {
50             if ($loaded) {
51                 $this->ok('Loaded config file: ' . $file);
52             } else {
53                 $this->info('Possible config file: ' . $file . ' (not loaded)');
54             }
55         }
56     }
57
58     public function checkDeps()
59     {
60         foreach ($this->deps as $package => $class) {
61             if (!class_exists($class, true)) {
62                 $this->fail('PEAR package not installed: ' . $package);
63             }
64         }
65
66         if (!class_exists('geshi', true)) {
67             $geshi = stream_resolve_include_path(
68                 $GLOBALS['phorkie']['cfg']['geshi']
69             );
70             if ($geshi === false) {
71                 $this->fail('GeSHi not available');
72             }
73         }
74
75         if (!class_exists('\\Michelf\\Markdown', true)) {
76             //PEAR-installed version 1.0.2 has a different API
77             $markdown = stream_resolve_include_path('markdown.php');
78             if ($markdown === false) {
79                 $this->fail('Markdown renderer not available');
80             }
81         }
82     }
83
84     public function checkDirs()
85     {
86         foreach ($this->writableDirs as $name => $dir) {
87             if (!is_dir($dir)) {
88                 $this->fail($name . ' directory does not exist at ' . $dir);
89             } else if (!is_writable($dir)) {
90                 $this->fail($name . ' directory is not writable at ' . $dir);
91             }
92         }
93     }
94
95     public function checkGit()
96     {
97         $line = exec('git --version', $lines, $retval);
98         if ($retval !== 0) {
99             $this->fail('Running git executable failed.');
100         }
101         if (!preg_match('#^git version ([0-9.]+(rc[0-9]+)?)$#', $line, $matches)) {
102             $this->fail('git version output format unexpected: ' . $line);
103         }
104         if (version_compare($matches[1], '1.7.5') < 0) {
105             $this->fail(
106                 'git version needs to be at least 1.7.5, got: ' . $matches[1]
107             );
108         }
109     }
110
111     public function checkDatabase()
112     {
113         if ($this->elasticsearch == '') {
114             return;
115         }
116
117         $es = parse_url($this->elasticsearch);
118         if (!preg_match("#/.+/#", $es['path'], $matches)) {
119             $this->fail(
120                 'Improper elasticsearch url.  Elasticsearch requires a'
121                 . ' search domain to store your data.'
122                 . ' (e.g. http://localhost:9200/phorkie/)'
123             );
124         }
125         $dbs = new Database();
126         $dbs->getSetup()->setup();
127     }
128
129     public function checkMimeTypeDetection()
130     {
131         $rp = new Repository_Post();
132         if ($rp->getType('<?php echo "foo"; ?>') != 'php') {
133             $this->fail('MIME type detection fails');
134         }
135     }
136
137     public function checkRemoteForking()
138     {
139         if (!isset($GLOBALS['phorkie']['cfg']['git']['public'])
140             || $GLOBALS['phorkie']['cfg']['git']['public'] == ''
141         ) {
142             $this->fail(
143                 'No public git URL prefix configured.'
144                 . ' Remote forking will not work'
145             );
146         }
147     }
148
149     public function fail($msg)
150     {
151         $this->messages[] = array('error', $msg);
152     }
153
154     public function info($msg)
155     {
156         $this->messages[] = array('info', $msg);
157     }
158
159     public function ok($msg)
160     {
161         $this->messages[] = array('ok', $msg);
162     }
163 }
164
165 ?>