This is the CLI interface for sabre-vobject. More...

Inheritance diagram for Sabre\VObject\Cli:

Collaboration diagram for Sabre\VObject\Cli:

Public Member Functions
	main (array $argv)
	Main function. More...

Protected Member Functions
	showHelp ()
	Shows the help message. More...

	validate (Component $vObj)
	Validates a VObject file. More...

	repair (Component $vObj)
	Repairs a VObject file. More...

	convert ($vObj)
	Converts a vObject file to a new format. More...

	color ($vObj)
	Colorizes a file. More...

	colorize ($color, $str, $resetTo='default')
	Returns an ansi color string for a color name. More...

	cWrite ($color, $str)
	Writes out a string in specific color. More...

	serializeComponent (Component $vObj)

	serializeProperty (Property $property)
	Colorizes a property. More...

	parseArguments (array $argv)
	Parses the list of arguments. More...

	readInput ()
	Reads the input file. More...

	log ($msg, $color='default')
	Sends a message to STDERR. More...

Protected Attributes
	$quiet = false

	$showHelp = false

	$format

	$pretty

	$inputPath

	$outputPath

	$stdout

	$stdin

	$stderr

	$inputFormat

	$forgiving = false

	$parser

Detailed Description

This is the CLI interface for sabre-vobject.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 15 of file Cli.php.

Member Function Documentation

◆ color()

Sabre\VObject\Cli::color ( $vObj )

protected

Colorizes a file.

Parameters

Component $vObj

Returns: int

Definition at line 493 of file Cli.php.

References Sabre\VObject\Cli\serializeComponent().

                                     {
 
         fwrite($this->stdout, $this->serializeComponent($vObj));
 
     }

Here is the call graph for this function:

◆ colorize()

Sabre\VObject\Cli::colorize	(	$color,
		$str,
		$resetTo = `'default'`
	)

protected

Returns an ansi color string for a color name.

Parameters

string $color

Returns: string

Definition at line 506 of file Cli.php.

Referenced by Sabre\VObject\Cli\cWrite(), Sabre\VObject\Cli\log(), Sabre\VObject\Cli\main(), Sabre\VObject\Cli\serializeProperty(), and Sabre\VObject\Cli\showHelp().

                                                                     {
 
         $colors = [
             'cyan'    => '1;36',
             'red'     => '1;31',
             'yellow'  => '1;33',
             'blue'    => '0;34',
             'green'   => '0;32',
             'default' => '0',
             'purple'  => '0;35',
         ];
         return "\033[" . $colors[$color] . 'm' . $str . "\033[" . $colors[$resetTo] . "m";
 
     }

Here is the caller graph for this function:

◆ convert()

Sabre\VObject\Cli::convert ( $vObj )

protected

Converts a vObject file to a new format.

Parameters

Component $vObj

Returns: int

Definition at line 427 of file Cli.php.

References Sabre\VObject\Document\VCARD21, Sabre\VObject\Document\VCARD30, and Sabre\VObject\Document\VCARD40.

                                       {
 
         $json = false;
         $convertVersion = null;
         $forceInput = null;
 
         switch ($this->format) {
             case 'json' :
                 $json = true;
                 if ($vObj->name === 'VCARD') {
                     $convertVersion = Document::VCARD40;
                 }
                 break;
             case 'jcard' :
                 $json = true;
                 $forceInput = 'VCARD';
                 $convertVersion = Document::VCARD40;
                 break;
             case 'jcal' :
                 $json = true;
                 $forceInput = 'VCALENDAR';
                 break;
             case 'mimedir' :
             case 'icalendar' :
             case 'icalendar20' :
             case 'vcard' :
                 break;
             case 'vcard21' :
                 $convertVersion = Document::VCARD21;
                 break;
             case 'vcard30' :
                 $convertVersion = Document::VCARD30;
                 break;
             case 'vcard40' :
                 $convertVersion = Document::VCARD40;
                 break;
 
         }
 
         if ($forceInput && $vObj->name !== $forceInput) {
             throw new \Exception('You cannot convert a ' . strtolower($vObj->name) . ' to ' . $this->format);
         }
         if ($convertVersion) {
             $vObj = $vObj->convert($convertVersion);
         }
         if ($json) {
             $jsonOptions = 0;
             if ($this->pretty) {
                 $jsonOptions = JSON_PRETTY_PRINT;
             }
             fwrite($this->stdout, json_encode($vObj->jsonSerialize(), $jsonOptions));
         } else {
             fwrite($this->stdout, $vObj->serialize());
         }
 
         return 0;
 
     }

◆ cWrite()

Sabre\VObject\Cli::cWrite	(	$color,
		$str
	)

protected

Writes out a string in specific color.

Parameters

string	$color
string	$str

Returns: void

Definition at line 529 of file Cli.php.

References Sabre\VObject\Cli\colorize().

Referenced by Sabre\VObject\Cli\serializeComponent(), and Sabre\VObject\Cli\serializeProperty().

                                             {
 
         fwrite($this->stdout, $this->colorize($color, $str));
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ log()

Sabre\VObject\Cli::log	(	$msg,
		$color = `'default'`
	)

protected

Sends a message to STDERR.

Parameters

string $msg

Returns: void

Definition at line 760 of file Cli.php.

References Sabre\VObject\Cli\colorize().

Referenced by Sabre\VObject\Cli\main(), Sabre\VObject\Cli\repair(), Sabre\VObject\Cli\showHelp(), and Sabre\VObject\Cli\validate().

                                                      {
 
         if (!$this->quiet) {
             if ($color !== 'default') {
                 $msg = $this->colorize($color, $msg);
             }
             fwrite($this->stderr, $msg . "\n");
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ main()

Sabre\VObject\Cli::main ( array $argv )

Main function.

Returns: int

Definition at line 99 of file Cli.php.

References Sabre\VObject\$input, $name, PHPMailer\PHPMailer\$options, Sabre\VObject\Cli\colorize(), Sabre\VObject\Cli\log(), Sabre\VObject\Cli\parseArguments(), Sabre\VObject\Cli\readInput(), Sabre\VObject\Cli\showHelp(), and Sabre\VObject\Version\VERSION.

                                {
 
         // @codeCoverageIgnoreStart
         // We cannot easily test this, so we'll skip it. Pretty basic anyway.
 
         if (!$this->stderr) {
             $this->stderr = fopen('php://stderr', 'w');
         }
         if (!$this->stdout) {
             $this->stdout = fopen('php://stdout', 'w');
         }
         if (!$this->stdin) {
             $this->stdin = fopen('php://stdin', 'r');
         }
 
         // @codeCoverageIgnoreEnd
 
 
         try {
 
             list($options, $positional) = $this->parseArguments($argv);
 
             if (isset($options['q'])) {
                 $this->quiet = true;
             }
             $this->log($this->colorize('green', "sabre/vobject ") . $this->colorize('yellow', Version::VERSION));
 
             foreach ($options as $name => $value) {
 
                 switch ($name) {
 
                     case 'q' :
                         // Already handled earlier.
                         break;
                     case 'h' :
                     case 'help' :
                         $this->showHelp();
                         return 0;
                         break;
                     case 'format' :
                         switch ($value) {
 
                             // jcard/jcal documents
                             case 'jcard' :
                             case 'jcal' :
 
                             // specific document versions
                             case 'vcard21' :
                             case 'vcard30' :
                             case 'vcard40' :
                             case 'icalendar20' :
 
                             // specific formats
                             case 'json' :
                             case 'mimedir' :
 
                             // icalendar/vcad
                             case 'icalendar' :
                             case 'vcard' :
                                 $this->format = $value;
                                 break;
 
                             default :
                                 throw new InvalidArgumentException('Unknown format: ' . $value);
 
                         }
                         break;
                     case 'pretty' :
                         if (version_compare(PHP_VERSION, '5.4.0') >= 0) {
                             $this->pretty = true;
                         }
                         break;
                     case 'forgiving' :
                         $this->forgiving = true;
                         break;
                     case 'inputformat' :
                         switch ($value) {
                             // json formats
                             case 'jcard' :
                             case 'jcal' :
                             case 'json' :
                                 $this->inputFormat = 'json';
                                 break;
 
                             // mimedir formats
                             case 'mimedir' :
                             case 'icalendar' :
                             case 'vcard' :
                             case 'vcard21' :
                             case 'vcard30' :
                             case 'vcard40' :
                             case 'icalendar20' :
 
                                 $this->inputFormat = 'mimedir';
                                 break;
 
                             default :
                                 throw new InvalidArgumentException('Unknown format: ' . $value);
 
                         }
                         break;
                     default :
                         throw new InvalidArgumentException('Unknown option: ' . $name);
 
                 }
 
             }
 
             if (count($positional) === 0) {
                 $this->showHelp();
                 return 1;
             }
 
             if (count($positional) === 1) {
                 throw new InvalidArgumentException('Inputfile is a required argument');
             }
 
             if (count($positional) > 3) {
                 throw new InvalidArgumentException('Too many arguments');
             }
 
             if (!in_array($positional[0], ['validate', 'repair', 'convert', 'color'])) {
                 throw new InvalidArgumentException('Uknown command: ' . $positional[0]);
             }
 
         } catch (InvalidArgumentException $e) {
             $this->showHelp();
             $this->log('Error: ' . $e->getMessage(), 'red');
             return 1;
         }
 
         $command = $positional[0];
 
         $this->inputPath = $positional[1];
         $this->outputPath = isset($positional[2]) ? $positional[2] : '-';
 
         if ($this->outputPath !== '-') {
             $this->stdout = fopen($this->outputPath, 'w');
         }
 
         if (!$this->inputFormat) {
             if (substr($this->inputPath, -5) === '.json') {
                 $this->inputFormat = 'json';
             } else {
                 $this->inputFormat = 'mimedir';
             }
         }
         if (!$this->format) {
             if (substr($this->outputPath, -5) === '.json') {
                 $this->format = 'json';
             } else {
                 $this->format = 'mimedir';
             }
         }
 
 
         $realCode = 0;
 
         try {
 
             while ($input = $this->readInput()) {
 
                 $returnCode = $this->$command($input);
                 if ($returnCode !== 0) $realCode = $returnCode;
 
             }
 
         } catch (EofException $e) {
             // end of file
         } catch (\Exception $e) {
             $this->log('Error: ' . $e->getMessage(), 'red');
             return 2;
         }
 
         return $realCode;
 
     }

Here is the call graph for this function:

◆ parseArguments()

Sabre\VObject\Cli::parseArguments ( array $argv )

protected

Parses the list of arguments.

Parameters

array $argv

Returns: void

Definition at line 690 of file Cli.php.

References $ii, and PHPMailer\PHPMailer\$options.

Referenced by Sabre\VObject\Cli\main().

                                                    {
 
         $positional = [];
         $options = [];
 
         for ($ii = 0; $ii < count($argv); $ii++) {
 
             // Skipping the first argument.
             if ($ii === 0) continue;
 
             $v = $argv[$ii];
 
             if (substr($v, 0, 2) === '--') {
                 // This is a long-form option.
                 $optionName = substr($v, 2);
                 $optionValue = true;
                 if (strpos($optionName, '=')) {
                     list($optionName, $optionValue) = explode('=', $optionName);
                 }
                 $options[$optionName] = $optionValue;
             } elseif (substr($v, 0, 1) === '-' && strlen($v) > 1) {
                 // This is a short-form option.
                 foreach (str_split(substr($v, 1)) as $option) {
                     $options[$option] = true;
                 }
 
             } else {
 
                 $positional[] = $v;
 
             }
 
         }
 
         return [$options, $positional];
 
     }

Here is the caller graph for this function:

◆ readInput()

Sabre\VObject\Cli::readInput ( )

protected

Reads the input file.

Returns: Component

Definition at line 735 of file Cli.php.

References Sabre\VObject\Reader\OPTION_FORGIVING.

Referenced by Sabre\VObject\Cli\main().

                                    {
 
         if (!$this->parser) {
             if ($this->inputPath !== '-') {
                 $this->stdin = fopen($this->inputPath, 'r');
             }
 
             if ($this->inputFormat === 'mimedir') {
                 $this->parser = new Parser\MimeDir($this->stdin, ($this->forgiving ? Reader::OPTION_FORGIVING : 0));
             } else {
                 $this->parser = new Parser\Json($this->stdin, ($this->forgiving ? Reader::OPTION_FORGIVING : 0));
             }
         }
 
         return $this->parser->parse();
 
     }

Here is the caller graph for this function:

◆ repair()

Sabre\VObject\Cli::repair ( Component $vObj )

protected

Repairs a VObject file.

Parameters

Component $vObj

Returns: int

Definition at line 379 of file Cli.php.

References $warnings, Sabre\VObject\Cli\log(), Sabre\VObject\Node\REPAIR, Sabre\VObject\Component\serialize(), and Sabre\VObject\Component\validate().

                                                {
 
         $returnCode = 0;
 
         switch ($vObj->name) {
             case 'VCALENDAR' :
                 $this->log("iCalendar: " . (string)$vObj->VERSION);
                 break;
             case 'VCARD' :
                 $this->log("vCard: " . (string)$vObj->VERSION);
                 break;
         }
 
         $warnings = $vObj->validate(Node::REPAIR);
         if (!count($warnings)) {
             $this->log("  No warnings!");
         } else {
 
             $levels = [
                 1 => 'REPAIRED',
                 2 => 'WARNING',
                 3 => 'ERROR',
             ];
             $returnCode = 2;
             foreach ($warnings as $warn) {
 
                 $extra = '';
                 if ($warn['node'] instanceof Property) {
                     $extra = ' (property: "' . $warn['node']->name . '")';
                 }
                 $this->log("  [" . $levels[$warn['level']] . '] ' . $warn['message'] . $extra);
 
             }
 
         }
         fwrite($this->stdout, $vObj->serialize());
 
         return $returnCode;
 
     }

Here is the call graph for this function:

◆ serializeComponent()

Sabre\VObject\Cli::serializeComponent ( Component $vObj )

protected

Gives a component a 'score' for sorting purposes.

This is solely used by the childrenSort method.

A higher score means the item will be lower in the list. To avoid score collisions, each "score category" has a reasonable space to accomodate elements. The $key is added to the $score to preserve the original relative order of elements.

Parameters

int	$key
array	$array

Returns: int

Definition at line 535 of file Cli.php.

References $key, Sabre\VObject\Component\children(), Sabre\VObject\Cli\cWrite(), and Sabre\VObject\Cli\serializeProperty().

Referenced by Sabre\VObject\Cli\color().

                                                            {
 
         $this->cWrite('cyan', 'BEGIN');
         $this->cWrite('red', ':');
         $this->cWrite('yellow', $vObj->name . "\n");
 
         $sortScore = function($key, $array) {
 
             if ($array[$key] instanceof Component) {
 
                 // We want to encode VTIMEZONE first, this is a personal
                 // preference.
                 if ($array[$key]->name === 'VTIMEZONE') {
                     $score = 300000000;
                     return $score + $key;
                 } else {
                     $score = 400000000;
                     return $score + $key;
                 }
             } else {
                 // Properties get encoded first
                 // VCARD version 4.0 wants the VERSION property to appear first
                 if ($array[$key] instanceof Property) {
                     if ($array[$key]->name === 'VERSION') {
                         $score = 100000000;
                         return $score + $key;
                     } else {
                         // All other properties
                         $score = 200000000;
                         return $score + $key;
                     }
                 }
             }
 
         };
 
         $children = $vObj->children();
         $tmp = $children;
         uksort(
             $children,
             function($a, $b) use ($sortScore, $tmp) {
 
                 $sA = $sortScore($a, $tmp);
                 $sB = $sortScore($b, $tmp);
 
                 return $sA - $sB;
 
             }
         );
 
         foreach ($children as $child) {
             if ($child instanceof Component) {
                 $this->serializeComponent($child);
             } else {
                 $this->serializeProperty($child);
             }
         }
 
         $this->cWrite('cyan', 'END');
         $this->cWrite('red', ':');
         $this->cWrite('yellow', $vObj->name . "\n");
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serializeProperty()

Sabre\VObject\Cli::serializeProperty ( Property $property )

protected

Colorizes a property.

Parameters

Property $property

Returns: void

Definition at line 621 of file Cli.php.

References Sabre\VObject\Cli\colorize(), Sabre\VObject\Cli\cWrite(), Sabre\VObject\Property\getParts(), Sabre\VObject\Property\getValue(), and Sabre\VObject\Property\parameters().

Referenced by Sabre\VObject\Cli\serializeComponent().

                                                              {
 
         if ($property->group) {
             $this->cWrite('default', $property->group);
             $this->cWrite('red', '.');
         }
 
         $this->cWrite('yellow', $property->name);
 
         foreach ($property->parameters as $param) {
 
             $this->cWrite('red', ';');
             $this->cWrite('blue', $param->serialize());
 
         }
         $this->cWrite('red', ':');
 
         if ($property instanceof Property\Binary) {
 
             $this->cWrite('default', 'embedded binary stripped. (' . strlen($property->getValue()) . ' bytes)');
 
         } else {
 
             $parts = $property->getParts();
             $first1 = true;
             // Looping through property values
             foreach ($parts as $part) {
                 if ($first1) {
                     $first1 = false;
                 } else {
                     $this->cWrite('red', $property->delimiter);
                 }
                 $first2 = true;
                 // Looping through property sub-values
                 foreach ((array)$part as $subPart) {
                     if ($first2) {
                         $first2 = false;
                     } else {
                         // The sub-value delimiter is always comma
                         $this->cWrite('red', ',');
                     }
 
                     $subPart = strtr(
                         $subPart,
                         [
                             '\\' => $this->colorize('purple', '\\\\', 'green'),
                             ';'  => $this->colorize('purple', '\;', 'green'),
                             ','  => $this->colorize('purple', '\,', 'green'),
                             "\n" => $this->colorize('purple', "\\n\n\t", 'green'),
                             "\r" => "",
                         ]
                     );
 
                     $this->cWrite('green', $subPart);
                 }
             }
 
         }
         $this->cWrite("default", "\n");
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showHelp()

Sabre\VObject\Cli::showHelp ( )

protected

Shows the help message.

Returns: void

Definition at line 282 of file Cli.php.

References Sabre\VObject\Cli\colorize(), and Sabre\VObject\Cli\log().

Referenced by Sabre\VObject\Cli\main().

                                   {
 
         $this->log('Usage:', 'yellow');
         $this->log("  vobject [options] command [arguments]");
         $this->log('');
         $this->log('Options:', 'yellow');
         $this->log($this->colorize('green', '  -q            ') . "Don't output anything.");
         $this->log($this->colorize('green', '  -help -h      ') . "Display this help message.");
         $this->log($this->colorize('green', '  --format      ') . "Convert to a specific format. Must be one of: vcard, vcard21,");
         $this->log($this->colorize('green', '  --forgiving   ') . "Makes the parser less strict.");
         $this->log("                vcard30, vcard40, icalendar20, jcal, jcard, json, mimedir.");
         $this->log($this->colorize('green', '  --inputformat ') . "If the input format cannot be guessed from the extension, it");
         $this->log("                must be specified here.");
         // Only PHP 5.4 and up
         if (version_compare(PHP_VERSION, '5.4.0') >= 0) {
             $this->log($this->colorize('green', '  --pretty      ') . "json pretty-print.");
         }
         $this->log('');
         $this->log('Commands:', 'yellow');
         $this->log($this->colorize('green', '  validate') . ' source_file              Validates a file for correctness.');
         $this->log($this->colorize('green', '  repair') . ' source_file [output_file]  Repairs a file.');
         $this->log($this->colorize('green', '  convert') . ' source_file [output_file] Converts a file.');
         $this->log($this->colorize('green', '  color') . ' source_file                 Colorize a file, useful for debbugging.');
         $this->log(
         <<<HELP
 
 If source_file is set as '-', STDIN will be used.
 If output_file is omitted, STDOUT will be used.
 All other output is sent to STDERR.
 
 HELP
         );
 
         $this->log('Examples:', 'yellow');
         $this->log('   vobject convert contact.vcf contact.json');
         $this->log('   vobject convert --format=vcard40 old.vcf new.vcf');
         $this->log('   vobject convert --inputformat=json --format=mimedir - -');
         $this->log('   vobject color calendar.ics');
         $this->log('');
         $this->log('https://github.com/fruux/sabre-vobject', 'purple');
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate()

Sabre\VObject\Cli::validate ( Component $vObj )

protected

Validates a VObject file.

Parameters

Component $vObj

Returns: int

Definition at line 332 of file Cli.php.

References $warnings, Sabre\VObject\Cli\log(), and Sabre\VObject\Component\validate().

                                                  {
 
         $returnCode = 0;
 
         switch ($vObj->name) {
             case 'VCALENDAR' :
                 $this->log("iCalendar: " . (string)$vObj->VERSION);
                 break;
             case 'VCARD' :
                 $this->log("vCard: " . (string)$vObj->VERSION);
                 break;
         }
 
         $warnings = $vObj->validate();
         if (!count($warnings)) {
             $this->log("  No warnings!");
         } else {
 
             $levels = [
                 1 => 'REPAIRED',
                 2 => 'WARNING',
                 3 => 'ERROR',
             ];
             $returnCode = 2;
             foreach ($warnings as $warn) {
 
                 $extra = '';
                 if ($warn['node'] instanceof Property) {
                     $extra = ' (property: "' . $warn['node']->name . '")';
                 }
                 $this->log("  [" . $levels[$warn['level']] . '] ' . $warn['message'] . $extra);
 
             }
 
         }
 
         return $returnCode;
 
     }

Here is the call graph for this function:

Field Documentation

◆ $forgiving

Sabre\VObject\Cli::$forgiving = false

protected

Definition at line 92 of file Cli.php.

◆ $format

Sabre\VObject\Cli::$format

protected

Definition at line 36 of file Cli.php.

◆ $inputFormat

Sabre\VObject\Cli::$inputFormat

protected

Definition at line 85 of file Cli.php.

◆ $inputPath

Sabre\VObject\Cli::$inputPath

protected

Definition at line 50 of file Cli.php.

◆ $outputPath

Sabre\VObject\Cli::$outputPath

protected

Definition at line 57 of file Cli.php.

◆ $parser

Sabre\VObject\Cli::$parser

protected

Definition at line 728 of file Cli.php.

◆ $pretty

Sabre\VObject\Cli::$pretty

protected

Definition at line 43 of file Cli.php.

◆ $quiet

Sabre\VObject\Cli::$quiet = false

protected

Definition at line 22 of file Cli.php.

◆ $showHelp

Sabre\VObject\Cli::$showHelp = false

protected

Definition at line 29 of file Cli.php.

◆ $stderr

Sabre\VObject\Cli::$stderr

protected

Definition at line 78 of file Cli.php.

◆ $stdin

Sabre\VObject\Cli::$stdin

protected

Definition at line 71 of file Cli.php.

◆ $stdout

Sabre\VObject\Cli::$stdout

protected

Definition at line 64 of file Cli.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/sabre/vobject/lib/Cli.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ color()

◆ colorize()

◆ convert()

◆ cWrite()

◆ log()

◆ main()

◆ parseArguments()

◆ readInput()

◆ repair()

◆ serializeComponent()

◆ serializeProperty()

◆ showHelp()

◆ validate()

Field Documentation

◆ $forgiving

◆ $format

◆ $inputFormat

◆ $inputPath

◆ $outputPath

◆ $parser

◆ $pretty

◆ $quiet

◆ $showHelp

◆ $stderr

◆ $stdin

◆ $stdout