1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<?php
/**
* Copyright (c) 2007-2011 bitExpert AG
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
require_once 'phing/Task.php';
require_once 'phing/tasks/system/ExecTask.php';
/**
* Abstract Liquibase task. Base class for all Liquibase Phing tasks.
*
* @author Stephan Hochdoerfer <S.Hochdoerfer@bitExpert.de>
* @version $Id$
* @since 2.4.10
* @package phing.tasks.ext.liquibase
*/
abstract class AbstractLiquibaseTask extends Task
{
protected $jar;
protected $changeLogFile;
protected $username;
protected $password;
protected $url;
protected $classpathref;
/**
* Sets the absolute path to liquibase jar.
*
* @param string the absolute path to the liquibase jar.
*/
public function setJar($jar)
{
$this->jar = $jar;
}
/**
* Sets the absolute path to the changelog file to use.
*
* @param string the absolute path to the changelog file
*/
public function setChangeLogFile($changelogFile)
{
$this->changeLogFile = $changelogFile;
}
/**
* Sets the username to connect to the database.
*
* @param string the username
*/
public function setUsername($username)
{
$this->username = $username;
}
/**
* Sets the password to connect to the database.
*
* @param string the password
*/
public function setPassword($password)
{
$this->password = $password;
}
/**
* Sets the url to connect to the database in jdbc style, e.g.
* <code>
* jdbc:postgresql://psqlhost/mydatabase
* </code>
*
* @param string jdbc connection string
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* Sets the Java classpathref.
*
* @param string A reference to the classpath that contains the database
* driver, liquibase.jar, and the changelog.xml file
*/
public function setclasspathref($classpathref)
{
$this->classpathref = $classpathref;
}
/**
* Ensure that correct parameters were passed in.
*
* @return void
*/
protected function checkParams()
{
if((null === $this->jar) or !file_exists($this->jar))
{
throw new BuildException(
sprintf(
'Specify the name of the LiquiBase.jar. "%s" does not exist!',
$this->jar
)
);
}
if((null === $this->changeLogFile) or !file_exists($this->changeLogFile))
{
throw new BuildException(
sprintf(
'Specify the name of the Changelog file. "%s" does not exist!',
$this->changeLogFile
)
);
}
if(null === $this->classpathref)
{
throw new BuildException('Please provide a classpath!');
}
if(null === $this->username)
{
throw new BuildException('Please provide a username for database acccess!');
}
if(null === $this->password)
{
throw new BuildException('Please provide a password for database acccess!');
}
if(null === $this->url)
{
throw new BuildException('Please provide a url for database acccess!');
}
}
/**
* Executes the given command and returns the output.
*
* @param string the command to execute
* @param string additional parameters
* @return string the output of the executed command
*/
protected function execute($lbcommand, $lbparams = '')
{
$command = sprintf(
'java -jar %s --changeLogFile=%s --url=%s --username=%s --password=%s --classpath=%s %s %s',
escapeshellarg($this->jar),
escapeshellarg($this->changeLogFile),
escapeshellarg($this->url),
escapeshellarg($this->username),
escapeshellarg($this->password),
escapeshellarg($this->classpathref),
escapeshellarg($lbcommand),
$lbparams
);
passthru($command);
return;
}
}
|
