├── index.php
├── README.md
├── class.JPCalendar.php
└── LICENSE


/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | require 'class.JPCalendar.php';
 3 | $cal=new Calendar();
 4 | $cal->setLang('en');
 5 | //$cal->setStartOfWeek('sunday');
 6 | //$cal->setDisplay('year',date('Y')); // [year|month|day],[YYYY]
 7 | $cal->setDisplay('month',date('Y').'-'.date('m')); // [year|month|day],[YYYY-MM]
 8 | $cal->setEvent('My first event is green','2014-03-01','2014-03-06','#00FF00');
 9 | $cal->setEvent('The second is blue','2014-03-10','2014-03-25','#0000FF');
10 | $cal->setEvent('The last is default color','2014-03-26','2014-03-29');
11 | echo $cal->render();
12 | ?>
13 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | JPCalendar
 2 | ==========
 3 | 
 4 | JeffProd-Calendar is a simple PHP class to display a monthly or yearly calendar with events.
 5 | 
 6 | It supports actually :
 7 | - language : fr, en (default fr)
 8 | - start of week : monday, sunday (default monday)
 9 | - rendering : monthly, yearly
10 | - events
11 | 
12 | Samples
13 | =======
14 | ```php
15 | require 'class.JPCalendar.php';
16 | $cal=new Calendar();
17 | $cal->setLang('en');
18 | $cal->setDisplay('month','2014-03'); // or for current date use : date('Y').'-'.date('m')
19 | $cal->setEvent('My first event is green','2014-03-01','2014-03-06','#00FF00');
20 | $cal->setEvent('The second is blue','2014-03-10','2014-03-25','#0000FF');
21 | $cal->setEvent('The last is default color','2014-03-26','2014-03-29');
22 | echo $cal->render();
23 | ```
24 | will render
25 | 
26 | ![month view](http://fr.jeffprod.com/img/2014-03-22-jpcalendar-mensuel.png)
27 | 
28 | ```php
29 | require 'class.JPCalendar.php';
30 | $cal=new Calendar();
31 | $cal->setLang('en');
32 | $cal->setDisplay('year','2014');
33 | $cal->setEvent('My first event is green','2014-03-01','2014-03-06','#00FF00');
34 | $cal->setEvent('The second is blue','2014-03-10','2014-03-25','#0000FF');
35 | $cal->setEvent('The last is default color','2014-03-26','2014-03-29');
36 | echo $cal->render();
37 | ```
38 | will render
39 | 
40 | ![year view](http://fr.jeffprod.com/img/2014-03-22-jpcalendar-annuel.png)
41 | 
42 | To set start of week, use
43 | 
44 | ```php
45 | $cal->setStartOfWeek('sunday'); // or monday
46 | ```
47 | 
48 | 


--------------------------------------------------------------------------------
/class.JPCalendar.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | //-----------------------------------------------------------------------
  3 | //  AUTHOR	: Jean-Francois GAZET
  4 | //  WEB		: http://www.jeffprod.com
  5 | //  TWITTER	: @JeffProd
  6 | //  MAIL	: jeffgazet@gmail.com
  7 | //  LICENCE	: GNU GENERAL PUBLIC LICENSE Version 2, June 1991
  8 | //-----------------------------------------------------------------------
  9 | // v0.3.3 : minor code optimization
 10 | // v0.3.2 : first release, minor rendering improvments
 11 | // v0.3.1 : display YEAR : ajout de bordures
 12 | // v0.3.0 : display MONTH ajouté + today en jaune
 13 | // v0.2.2 : display YEAR : choix de couleur pour les evenements
 14 | // v0.2.1 : display YEAR : ajout style CSS + sélecteur d'année
 15 | // v0.2.0 : choix du premier jour de semaine (lundi ou dimanche)
 16 | // v0.1.0 : display YEAR fonctionnel avec 1er jour de semaine = dimanche
 17 | //-----------------------------------------------------------------------
 18 | 
 19 | class Calendar
 20 | 	{
 21 | 	private $_lng;
 22 | 	private $_lngDays; // days translation
 23 | 	private $_lngMonths; // months translation
 24 | 	private $_lngOther; // other translations
 25 | 	private $_startOfWeek; // first day of week : monday or sunday
 26 | 	private $_display; // display mode : month,day,year
 27 | 	private $_eventLabel; // event to display
 28 | 	private $_eventColor; // color event
 29 | 	private $_eventFrom; // date from 'YYYY-MM-DD HH:II'
 30 | 	private $_eventTo; // date to 'YYYY-MM-DD HH:II'
 31 | 	private $_dateToday; // date to prevent multiple calls to date()
 32 | 	
 33 | 	public function __construct()
 34 | 		{
 35 | 		date_default_timezone_set('Europe/Paris');
 36 | 
 37 | 		// default values
 38 | 		$this->_lng='fr';
 39 | 		$this->_startOfWeek='monday';
 40 | 		$this->_eventLabel=array();
 41 | 		$this->_eventFrom=array();
 42 | 		$this->_eventTo=array();
 43 | 		$this->_eventColor=array();
 44 | 		$this->_dateToday=array
 45 | 			(
 46 | 			'd'=>date('d'),
 47 | 			'm'=>date('m'),
 48 | 			'Y'=>date('Y')
 49 | 			);
 50 | 
 51 | 		self::setStartOfWeek($this->_startOfWeek); // calls setLang()
 52 | 		self::setDisplay('year',$this->_dateToday['Y']); 
 53 | 		}
 54 | 
 55 | 	public function setStartOfWeek($txt)
 56 | 		{
 57 | 		if(!($txt=='monday' || $txt=='sunday')) 
 58 | 			{
 59 | 			self::errorMsg('setStartOfWeek','start of week "'.$txt.'" not supported. Must be "monday" or "sunday"');
 60 | 			return;
 61 | 			}
 62 | 
 63 | 		$this->_startOfWeek=$txt;
 64 | 		self::setLang($this->_lng);
 65 | 		}
 66 | 
 67 | 	public function setLang($lng)
 68 | 		{
 69 | 		switch($lng)
 70 | 			{
 71 | 			case 'fr':
 72 | 			$this->_lng='fr';
 73 | 			if($this->_startOfWeek=='sunday') {$this->_lngDays=array('Dimanche','Lundi','Mardi','Mercredi','Jeudi','Vendredi','Samedi');}
 74 | 			else {$this->_lngDays=array('Lundi','Mardi','Mercredi','Jeudi','Vendredi','Samedi','Dimanche');}			
 75 | 			$this->_lngMonths=array('Janvier','Février','Mars','Avril','Mai','Juin','Juillet','Août','Septembre','Octobre','Novembre','Décembre');
 76 | 			$this->_lngOther=array('Aujourd\'hui','Précédent','Suivant');
 77 | 			break;
 78 | 	
 79 | 			case 'en':
 80 | 			$this->_lng='en';
 81 | 			if($this->_startOfWeek=='sunday') {$this->_lngDays=array('Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Satursday');}
 82 | 			else {$this->_lngDays=array('Monday','Tuesday','Wednesday','Thursday','Friday','Satursday','Sunday');}
 83 | 			$this->_lngMonths=array('January','February','March','April','May','June','July','August','September','October','November','December');
 84 | 			$this->_lngOther=array('Today','Previous','Next');
 85 | 			break;
 86 | 
 87 | 			default:
 88 | 			self::errorMsg('setLang','language "'.$lng.'" not supported');
 89 | 			break;
 90 | 			}		
 91 | 		}
 92 | 
 93 | 	// affiche un évènement dans l'agenda, dates au format 'YYYY-MM-DD HH:II'
 94 | 	public function setEvent($txt,$from,$to,$color='#FF0000')
 95 | 		{
 96 | 		$this->_eventLabel[]=$txt;
 97 | 		$this->_eventColor[]=$color;
 98 | 
 99 | 		//list($date,$heure)=explode(' ',$from); //'2014-03-01 15:00'
100 | 		list($an,$mois,$jour)=explode('-',$from);
101 | 		//list($h,$mn)=explode(':',$heure);
102 | 		$this->_eventFrom['jour'][]=$jour;
103 | 		$this->_eventFrom['mois'][]=$mois;
104 | 		$this->_eventFrom['an'][]=$an;
105 | 		//$this->_eventFrom['heure'][]=$h;
106 | 		//$this->_eventFrom['mn'][]=$mn;
107 | 
108 | 		//list($date,$heure)=explode(' ',$to); //'2014-03-01 15:00'
109 | 		list($an,$mois,$jour)=explode('-',$to);
110 | 		//list($h,$mn)=explode(':',$heure);
111 | 		$this->_eventTo['jour'][]=$jour;
112 | 		$this->_eventTo['mois'][]=$mois;
113 | 		$this->_eventTo['an'][]=$an;
114 | 		//$this->_eventTo['heure'][]=$h;
115 | 		//$this->_eventTo['mn'][]=$mn;
116 | 		}
117 | 
118 | 	// choix de l'affichage : year|month|day and its value (i.e. 2014 for year 02 for month or day)
119 | 	public function setDisplay($choice,$value)
120 | 		{
121 | 		// valeurs testées dans render()
122 | 		if(isset($_GET['calDate'])) {$value=$_GET['calDate'];}
123 | 		$this->_display=array($choice,$value);
124 | 		}
125 | 
126 | 	public function render()
127 | 		{
128 | 		$y=''; $m=''; $d='';
129 | 		if(preg_match('~\d{4}\-\d{2}\-\d{2}~',$this->_display[1]))
130 | 			{
131 | 			list($y,$m,$d)=explode('-',$this->_display[1]);
132 | 			}
133 | 		elseif(preg_match('~\d{4}\-\d{2}~',$this->_display[1]))
134 | 			{
135 | 			list($y,$m)=explode('-',$this->_display[1]);
136 | 			}
137 | 		else
138 | 			{
139 | 			$y=$this->_display[1];
140 | 			}
141 | 		switch($this->_display[0])
142 | 			{
143 | 			case 'day':
144 | 			return self::renderDay($y,$m,$d);
145 | 			break;
146 | 			
147 | 			case 'month':
148 | 			if(self::isYear($y) && self::isMonth($m)) {return self::renderMonth($y,$m);}
149 | 			self::errorMsg('render','date must be YYYY-MM (year-month, i.e. : 2014-04)');
150 | 			break;
151 | 			
152 | 			case 'year':
153 | 			if(self::isYear($y)) {return self::renderYear($y);}
154 | 			self::errorMsg('render','"'.$this->_display[1].'" is not a year (YYYY)');
155 | 			break;
156 | 
157 | 			default: 
158 | 			self::errorMsg('render','display "'.$this->_display[0].'" not supported. Must be : day,month,year');
159 | 			break;
160 | 			}
161 | 		}
162 | 
163 | 	// check if arg is a year like 'YYYY' (i.e. 2014)
164 | 	private static function isYear($y)
165 | 		{
166 | 		if(!preg_match('/(\d){4}/',$y)) {return false;}
167 | 		if($y>9999) {return false;}
168 | 		if($y<1) {return false;}
169 | 		return true;
170 | 		}
171 | 
172 | 	// check if arg is date like 'YYYY-MM' (i.e. 2014-03)
173 | 	private static function isMonth($m)
174 | 		{
175 | 		if(!preg_match('/^(\d){2}$/',$m)) {return false;}
176 | 		if($m>12) {return false;}
177 | 		if($m<1) {return false;}
178 | 		return true;
179 | 		}
180 | 
181 | 	private function errorMsg($function,$txt)
182 | 		{
183 | 		echo 'Calendar - '.$function.'() : '.$txt.'.';
184 | 		}
185 | 
186 | 	private function renderDay()
187 | 		{
188 | 		;
189 | 		}
190 | 
191 | 	private function renderMonth($y,$m)
192 | 		{
193 | 		$r='';
194 | 
195 | 		// getting first day of each month
196 | 		$firstDayofMonth=self::getFirstDayofMonth($m,$y);
197 | 
198 | 		// getting number of days in each month : 28 to 31 
199 | 		$lastDayofMonth=self::getLastDayofMonth($m,$y);
200 | 
201 | 		$r.=self::styleCSS();
202 | 
203 | 		$r.='<table border="1">'.PHP_EOL;
204 | 		$r.='<tbody>'.PHP_EOL;
205 | 
206 | 		$r.='<tr class="calHead">';
207 | 		$r.='<td>'.self::monthYearSelect($m,$y).'</td>'.PHP_EOL;
208 | 		// table header = 7 days
209 | 		for($i=0;$i<7;$i++) {$r.='<td>'.substr($this->_lngDays[$i],0,2).'</td>'.PHP_EOL;}
210 | 		$r.='</tr>'.PHP_EOL;
211 | 
212 | 		$cpt=1;
213 | 		$numweek=self::getNumberOfWeek($y,$m,1); // first week number
214 | 
215 | 		// 6 rows
216 | 		for($j=0;$j<6;$j++) 
217 | 			{
218 | 			$r.='<tr>';
219 | 			$r.='<td class="calHead">'.$numweek.'</td>'.PHP_EOL; $numweek++;
220 | 			for($i=0;$i<7;$i++) 
221 | 				{
222 | 				if(($firstDayofMonth==$i || $cpt>1) && $cpt<=$lastDayofMonth) 
223 | 					{
224 | 					$r.='<td'.self::setCellColor($cpt,$m,$y).'>';
225 | 					$r.=$cpt;
226 | 					$cpt++;
227 | 					$r.='</td>'.PHP_EOL;					
228 | 					}
229 | 				else {$r.='<td></td>'.PHP_EOL;}
230 | 				}
231 | 			$r.='</tr>'.PHP_EOL;
232 | 			}
233 | 
234 | 		$r.='</tbody>'.PHP_EOL;
235 | 		$r.='</table>'.PHP_EOL;
236 | 
237 | 		return $r;
238 | 		}
239 | 
240 | 	private function renderYear($year)
241 | 		{
242 | 		// 	Su Mo ...
243 | 		// jan  1..31 ...
244 | 		// fev  1..31 ...
245 | 		// ...
246 | 		$r=self::styleCSS();
247 | 
248 | 		$r.='<table>'.PHP_EOL;
249 | 		$r.='<tbody>'.PHP_EOL;
250 | 		$r.='<tr class="calHead">'.PHP_EOL;
251 | 		$r.='<td>'.self::yearSelect($year).'</td>'.PHP_EOL;
252 | 
253 | 		// table header = days
254 | 		// 6 weeks in a row
255 | 		for($nbweeks=0;$nbweeks<6;$nbweeks++)
256 | 			{
257 | 			// 7 days a week
258 | 			for($i=0;$i<7;$i++) {$r.='<td';  if($i==0) {$r.=' class="calBordL"';} $r.='>'.substr($this->_lngDays[$i],0,2).'</td>'.PHP_EOL;}
259 | 			}
260 | 
261 | 		$r.='</tr>'.PHP_EOL;
262 | 
263 | 		// 12 rows for each month
264 | 		for($nbmois=0;$nbmois<12;$nbmois++)
265 | 			{
266 | 			$cpt=1;	
267 | 
268 | 			// getting first day of month
269 | 			$firstDayofMonth[$nbmois]=self::getFirstDayofMonth($nbmois+1,$year);
270 | 
271 | 			// getting number of days in month : 28 to 31 
272 | 			$lastDayofMonth[$nbmois]=self::getLastDayofMonth($nbmois+1,$year);
273 | 			
274 | 			$r.='<tr>'.PHP_EOL;
275 | 			$r.='<td class="calHead">'.$this->_lngMonths[$nbmois].'</td>'.PHP_EOL;
276 | 
277 | 			// 6 weeks in a row
278 | 			for($nbweeks=0;$nbweeks<6;$nbweeks++)
279 | 				{
280 | 				// 7 days a week
281 | 				for($nbj=0;$nbj<7;$nbj++) 
282 | 					{
283 | 					if(($firstDayofMonth[$nbmois]==$nbj || $cpt>1) && $cpt<=$lastDayofMonth[$nbmois]) 
284 | 						{
285 | 						$r.='<td'.self::setCellColor($cpt,$nbmois+1,$year);  if($nbj==0) {$r.=' class="calBordL"';} $r.='>';
286 | 						$r.=$cpt;
287 | 						$cpt++;
288 | 						$r.='</td>'.PHP_EOL;					
289 | 						}
290 | 					else {$r.='<td'; if($nbj==0) {$r.=' class="calBordL"';} $r.='></td>'.PHP_EOL;}					
291 | 					}
292 | 				}
293 | 			$r.='</tr>'.PHP_EOL;
294 | 			}
295 | 
296 | 		$r.='</tbody>'.PHP_EOL;
297 | 		$r.='</table>'.PHP_EOL;
298 | 
299 | 		return $r;
300 | 		}
301 | 	
302 | 	// Navigation buttons for year display
303 | 	private function yearSelect($year)
304 | 		{
305 | 		$r='';
306 | 
307 | 		// Previous year button
308 | 		if($year-1>0) {$r.='<input type="button" onClick="document.location.href=\'?calDate='.($year-1).'\'" value="&lt;&lt;">'.PHP_EOL;}
309 | 
310 | 		// Current year
311 | 		$r.=$year;
312 | 
313 | 		// Next year button
314 | 		if($year+1<10000) {$r.=' <input type="button" onClick="document.location.href=\'?calDate='.($year+1).'\'" value="&gt;&gt;">'.PHP_EOL;}
315 | 
316 | 		// Today button
317 | 		$r.='<br><input type="button" onClick="document.location.href=\'?calDate='.$this->_dateToday['Y'].'\'" value="'.$this->_lngOther[0].'">'.PHP_EOL;
318 | 
319 | 		return $r;
320 | 		}
321 | 
322 | 	// Navigation buttons for month display
323 | 	private function monthYearSelect($m,$y)
324 | 		{
325 | 		$r='';
326 | 
327 | 		// Previous month button (YYYY-MM)
328 | 		$previous=$y.'-'.(($m-1<10)?'0'.($m-1):($m-1));
329 | 		if($m-1<1) {$previous=($y-1).'-12';}
330 | 		if($y-1>0) {$r.='<input type="button" onClick="document.location.href=\'?calDate='.$previous.'\'" value="&lt;&lt;">'.PHP_EOL;}
331 | 
332 | 		// Current month
333 | 		$r.=$this->_lngMonths[$m-1].' '.$y;
334 | 
335 | 		// Next month button (YYYY-MM)
336 | 		$next=$y.'-'.(($m+1<10)?'0'.($m+1):($m+1));
337 | 		if($m+1>12) {$next=($y+1).'-01';}
338 | 		if($y+1<10000) {$r.=' <input type="button" onClick="document.location.href=\'?calDate='.$next.'\'" value="&gt;&gt;">'.PHP_EOL;}
339 | 
340 | 		// Today button
341 | 		$r.='<br><input type="button" onClick="document.location.href=\'?calDate='.$this->_dateToday['Y'].'-'.$this->_dateToday['m'].'\'" value="'.$this->_lngOther[0].'">'.PHP_EOL;
342 | 
343 | 		return $r;
344 | 		}
345 | 
346 | 	// CSS style
347 | 	private static function styleCSS()
348 | 		{
349 | 		$r='';
350 | 		$r.='<style type="text/css">'.PHP_EOL;
351 | 
352 | 		$r.='table {'.PHP_EOL;
353 | 		$r.=' -webkit-print-color-adjust: exact;'.PHP_EOL; // pour imprimer les couleurs de cellules
354 | 		$r.=' border-spacing: 0px;'.PHP_EOL; 
355 | 		$r.=' border-padding: 0px;'.PHP_EOL; 
356 | 		$r.=' border: 1px solid black;'.PHP_EOL;
357 | 		$r.=' border-top: 0px;'.PHP_EOL; 
358 | 		$r.=' border-left: 0px;'.PHP_EOL; 
359 | 		$r.=' }'.PHP_EOL;
360 | 
361 | 		$r.='td {'.PHP_EOL; 
362 | 		$r.=' text-align: center;'.PHP_EOL;
363 | 		$r.=' width: 20px;'.PHP_EOL;
364 | 		$r.=' border-top: 1px solid black;'.PHP_EOL; 
365 | 		$r.=' border-left: 1px solid black;'.PHP_EOL; 
366 | 		$r.='}'.PHP_EOL; 
367 | 
368 | 		$r.='.calHead {'.PHP_EOL;  
369 | 		$r.=' font-weight: bold;'.PHP_EOL; 
370 | 		$r.=' background: #ccc;'.PHP_EOL;
371 | 		$r.=' white-space: nowrap;'.PHP_EOL;
372 | 		$r.=' }'.PHP_EOL;
373 | 
374 | 		$r.='.calBordL {'.PHP_EOL;  
375 | 		$r.=' border-left: 3px solid black;'.PHP_EOL; 
376 | 		$r.=' }'.PHP_EOL;
377 | 
378 | 		$r.='</style>'.PHP_EOL;
379 | 		return $r;
380 | 		}
381 | 
382 | 	// return first day of month 
383 | 	// $month : 1 to 12
384 | 	// $year : int
385 | 	// return : 0..6 (sunday to satursday) or 1..7 (monday to sunday)
386 | 	private function getFirstDayofMonth($month,$year)
387 | 		{
388 | 		if($this->_startOfWeek=='sunday')
389 | 			{
390 | 			return date('w',mktime (0, 0, 0, $month, 1, $year)); // 0(di) to 6(sa)
391 | 			}
392 | 		else
393 | 			{
394 | 			return date('N',mktime (0, 0, 0, $month, 1, $year))-1; // 1(lu) to 7(di)
395 | 			}
396 | 		}
397 | 
398 | 	// return last day of month 
399 | 	// $month : 1 to 12
400 | 	// $year : int
401 | 	// return : 28,29,30 or 31
402 | 	private static function getLastDayofMonth($month,$year)
403 | 		{
404 | 		return date('t',mktime (0, 0, 0, $month, 15, $year));
405 | 		}
406 | 
407 | 	// Returns the ISO number of week
408 | 	private static function getNumberOfWeek($y,$m,$d)
409 | 		{
410 | 		return intval(date('W',mktime(0,0,0,$m,$d,$y)));
411 | 		}
412 | 
413 | 	// Returns cell color an title for events and today
414 | 	private function setCellColor($d,$m,$y)
415 | 		{
416 | 		$r='';
417 | 		$color='';
418 | 		$title='';
419 | 
420 | 		// today cell in yellow
421 | 		if($d==$this->_dateToday['d'] && $m==$this->_dateToday['m'] && $y==$this->_dateToday['Y']) {$color='#FFFF00';}
422 | 
423 | 		$mktime=mktime(0,0,0,$m,$d,$y);
424 | 		while (list($key, $value) = each($this->_eventLabel))
425 | 			{
426 | 			if(
427 | 			$mktime>=mktime(0, 0, 0, $this->_eventFrom['mois'][$key], $this->_eventFrom['jour'][$key], $this->_eventFrom['an'][$key]) && // mktime:h,m,s,mois,jour,an 
428 | 			$mktime<=mktime(0, 0, 0, $this->_eventTo['mois'][$key], $this->_eventTo['jour'][$key], $this->_eventTo['an'][$key])
429 | 			)
430 | 				{
431 | 				// there is an event on this day so we set color and title
432 | 				if($color=='') {$color=$this->_eventColor[$key];}
433 | 				$title=$value;
434 | 				break;
435 | 				}
436 | 			}
437 | 		reset($this->_eventLabel);
438 | 
439 | 		if($color!='') {$r.=' style="background-color: '.$color.';"';}
440 | 		if($title!='') {$r.=' title="'.$title.'"';}
441 | 
442 | 		return $r;	
443 | 		}
444 | 
445 | 	} // Class
446 | ?>
447 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | GNU GENERAL PUBLIC LICENSE
  2 |                        Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
  5 |  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 |                             Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                     GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 |                             NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 
280 |                      END OF TERMS AND CONDITIONS
281 | 
282 |             How to Apply These Terms to Your New Programs
283 | 
284 |   If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 | 
288 |   To do so, attach the following notices to the program.  It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 | 
293 |     {description}
294 |     Copyright (C) {year}  {fullname}
295 | 
296 |     This program is free software; you can redistribute it and/or modify
297 |     it under the terms of the GNU General Public License as published by
298 |     the Free Software Foundation; either version 2 of the License, or
299 |     (at your option) any later version.
300 | 
301 |     This program is distributed in the hope that it will be useful,
302 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
303 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304 |     GNU General Public License for more details.
305 | 
306 |     You should have received a copy of the GNU General Public License along
307 |     with this program; if not, write to the Free Software Foundation, Inc.,
308 |     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 | 
310 | Also add information on how to contact you by electronic and paper mail.
311 | 
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 | 
315 |     Gnomovision version 69, Copyright (C) year name of author
316 |     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 |     This is free software, and you are welcome to redistribute it
318 |     under certain conditions; type `show c' for details.
319 | 
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License.  Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 | 
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary.  Here is a sample; alter the names:
328 | 
329 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 |   `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 | 
332 |   {signature of Ty Coon}, 1 April 1989
333 |   Ty Coon, President of Vice
334 | 
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs.  If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library.  If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.


--------------------------------------------------------------------------------