Fix: d'Aboville numbers on descendancy chart

2 files changed, 365 insertions, 6 deletions

diff --git a/app/Functions/FunctionsCharts.php b/app/Functions/FunctionsCharts.php
index dd5e606516..4171839641 100644
--- a/app/Functions/FunctionsCharts.php
+++ b/app/Functions/FunctionsCharts.php
@@ -97,12 +97,12 @@ class FunctionsCharts
 
         if ($parid) {
             if ($husb->getXref() == $parid) {
-                self::printSosaNumber($label, '', 'arrow-up');
+                self::printSosaNumber($label, '', 'blank');
             } else {
-                self::printSosaNumber($label, '', 'arrow-up');
+                self::printSosaNumber($label, '', '');
             }
         } elseif ($sosa) {
-            self::printSosaNumber($sosa * 2, '', 'arrow-up');
+            self::printSosaNumber($sosa * 2, '', '');
         }
         if ($husb->isPendingAddition()) {
             echo '<td class="new">';
@@ -187,12 +187,12 @@ class FunctionsCharts
         echo '<table cellspacing="0" cellpadding="0" border="0"><tr>';
         if ($parid) {
             if ($wife->getXref() == $parid) {
-                self::printSosaNumber($label, '', 'arrow-up');
+                self::printSosaNumber($label, '', 'blank');
             } else {
-                self::printSosaNumber($label, '', 'arrow-up');
+                self::printSosaNumber($label, '', '');
             }
         } elseif ($sosa) {
-            self::printSosaNumber($sosa * 2 + 1, '', 'arrow-up');
+            self::printSosaNumber($sosa * 2 + 1, '', '');
         }
         if ($wife->isPendingAddition()) {
             echo '<td class="new">';
diff --git a/app/Services/GedcomService.php b/app/Services/GedcomService.php
new file mode 100644
index 0000000000..fdbe17e792
--- /dev/null
+++ b/app/Services/GedcomService.php
@@ -0,0 +1,359 @@
+<?php
+/**
+ * webtrees: online genealogy
+ * Copyright (C) 2018 webtrees development team
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+declare(strict_types=1);
+
+namespace Fisharebest\Webtrees\Services;
+
+/**
+ * Utilities for manipulating GEDCOM data.
+ */
+class GedcomService
+{
+    // Gedcom allows 255 characters (not bytes), including the EOL character.
+    const EOL         = "\r\n";
+    const EOL_REGEX   = '\r|\r\n|\n|\n\r';
+    const LINE_LENGTH = 255 - 2;
+
+
+    // User defined tags begin with an underscore
+    const USER_DEFINED_TAG_PREFIX = '_';
+
+    // Some applications, such as FTM, use GEDCOM tag names instead of the tags.
+    const TAG_NAMES = [
+        'ABBREVIATION'      => 'ABBR',
+        'ADDRESS'           => 'ADDR',
+        'ADDRESS1'          => 'ADR1',
+        'ADDRESS2'          => 'ADR2',
+        'ADOPTION'          => 'ADOP',
+        'AFN'               => 'AFN',
+        'AGE'               => 'AGE',
+        'AGENCY'            => 'AGNC',
+        'ALIAS'             => 'ALIA',
+        'ANCESTORS'         => 'ANCE',
+        'ANCES_INTEREST'    => 'ANCI',
+        'ANULMENT'          => 'ANUL',
+        'ASSOCIATES'        => 'ASSO',
+        'AUTHOR'            => 'AUTH',
+        'BAPTISM-LDS'       => 'BAPL',
+        'BAPTISM'           => 'BAPM',
+        'BAR_MITZVAH'       => 'BARM',
+        'BAS_MITZVAH'       => 'BASM',
+        'BIRTH'             => 'BIRT',
+        'BLESSING'          => 'BLES',
+        'BURIAL'            => 'BURI',
+        'CALL_NUMBER'       => 'CALN',
+        'CASTE'             => 'CAST',
+        'CAUSE'             => 'CAUS',
+        'CENSUS'            => 'CENS',
+        'CHANGE'            => 'CHAN',
+        'CHARACTER'         => 'CHAR',
+        'CHILD'             => 'CHIL',
+        'CHRISTENING'       => 'CHR',
+        'ADULT_CHRISTENING' => 'CHRA',
+        'CITY'              => 'CITY',
+        'CONCATENATION'     => 'CONC',
+        'CONFIRMATION'      => 'CONF',
+        'CONFIRMATION-LDS'  => 'CONL',
+        'CONTINUED'         => 'CONT',
+        'COPYRIGHT'         => 'COPY',
+        'CORPORTATE'        => 'CORP',
+        'CREMATION'         => 'CREM',
+        'COUNTRY'           => 'CTRY',
+        'DATA'              => 'DATA',
+        'DATE'              => 'DATE',
+        'DEATH'             => 'DEAT',
+        'DESCENDANTS'       => 'DESC',
+        'DESCENDANTS_INT'   => 'DESI',
+        'DESTINATION'       => 'DEST',
+        'DIVORCE'           => 'DIV',
+        'DIVORCE_FILED'     => 'DIVF',
+        'PHY_DESCRIPTION'   => 'DSCR',
+        'EDUCATION'         => 'EDUC',
+        'EMAIL'             => 'EMAI',
+        'EMIGRATION'        => 'EMIG',
+        'ENDOWMENT'         => 'ENDL',
+        'ENGAGEMENT'        => 'ENGA',
+        'EVENT'             => 'EVEN',
+        'FACT'              => 'FACT',
+        'FAMILY'            => 'FAM',
+        'FAMILY_CHILD'      => 'FAMC',
+        'FAMILY_FILE'       => 'FAMF',
+        'FAMILY_SPOUSE'     => 'FAMS',
+        'FACIMILIE'         => 'FAX',
+        'FIRST_COMMUNION'   => 'FCOM',
+        'FILE'              => 'FILE',
+        'FORMAT'            => 'FORM',
+        'PHONETIC'          => 'FONE',
+        'GEDCOM'            => 'GEDC',
+        'GIVEN_NAME'        => 'GIVN',
+        'GRADUATION'        => 'GRAD',
+        'HEADER'            => 'HEAD',
+        'HUSBAND'           => 'HUSB',
+        'IDENT_NUMBER'      => 'IDNO',
+        'IMMIGRATION'       => 'IMMI',
+        'INDIVIDUAL'        => 'INDI',
+        'LANGUAGE'          => 'LANG',
+        'LATITUDE'          => 'LATI',
+        'LONGITUDE'         => 'LONG',
+        'MAP'               => 'MAP',
+        'MARRIAGE_BANN'     => 'MARB',
+        'MARR_CONTRACT'     => 'MARC',
+        'MARR_LICENSE'      => 'MARL',
+        'MARRIAGE'          => 'MARR',
+        'MEDIA'             => 'MEDI',
+        'NAME'              => 'NAME',
+        'NATIONALITY'       => 'NATI',
+        'NATURALIZATION'    => 'NATU',
+        'CHILDREN_COUNT'    => 'NCHI',
+        'NICKNAME'          => 'NICK',
+        'MARRIAGE_COUNT'    => 'NMR',
+        'NOTE'              => 'NOTE',
+        'NAME_PREFIX'       => 'NPFX',
+        'NAME_SUFFIX'       => 'NSFX',
+        'OBJECT'            => 'OBJE',
+        'OCCUPATION'        => 'OCCU',
+        'ORDINANCE'         => 'ORDI',
+        'ORDINATION'        => 'ORDN',
+        'PAGE'              => 'PAGE',
+        'PEDIGREE'          => 'PEDI',
+        'PHONE'             => 'PHON',
+        'PLACE'             => 'PLAC',
+        'POSTAL_CODE'       => 'POST',
+        'PROBATE'           => 'PROB',
+        'PROPERTY'          => 'PROP',
+        'PUHBLICATION'      => 'PUBL',
+        'QUALITY_OF_DATA'   => 'QUAY',
+        'REFERENCE'         => 'REFN',
+        'RELATIONSHIP'      => 'RELA',
+        'RELIGION'          => 'RELI',
+        'REPOSITORY'        => 'REPO',
+        'RESIDENCE'         => 'RESI',
+        'RESTRICTION'       => 'RESN',
+        'RETIREMENT'        => 'RETI',
+        'REC_FILE_NUMBER'   => 'RFN',
+        'REC_ID_NUMBER'     => 'RIN',
+        'ROLE'              => 'ROLE',
+        'ROMANIZED'         => 'ROMN',
+        'SEALING_CHILD'     => 'SLGC',
+        'SEALING_SPOUSE'    => 'SLGS',
+        'SEX'               => 'SEX',
+        'SOURCE'            => 'SOUR',
+        'SURN_PREFIX'       => 'SPFX',
+        'SOC_SEC_NUMBER'    => 'SSN',
+        'STATE'             => 'STAE',
+        'STATUS'            => 'STAT',
+        'SUBMITTER'         => 'SUBM',
+        'SUBMISSION'        => 'SUBN',
+        'SURNAME'           => 'SURN',
+        'TEMPLE'            => 'TEMP',
+        'TEXT'              => 'TEXT',
+        'TIME'              => 'TIME',
+        'TITLE'             => 'TITL',
+        'TRAILER'           => 'TRLR',
+        'TYPE'              => 'TYPE',
+        'VERSION'           => 'VERS',
+        'WIFE'              => 'WIFE',
+        'WILL'              => 'WILL',
+        'WEB'               => 'WWW',
+        '_DEATH_OF_SPOUSE'  => 'DETS',
+        '_DEGREE'           => '_DEG',
+        '_FILE'             => 'FILE',
+        '_MEDICAL'          => '_MCL',
+        '_MILITARY_SERVICE' => '_MILT',
+    ];
+
+    // Custom tags used by other applications, with direct synonyms
+    const TAG_SYNONYMS = [
+    ];
+
+    // LATI and LONG tags
+    const DEGREE_FORMAT  = ' % .5f%s';
+    const LATITUDE_NORTH = 'N';
+    const LATITUDE_SOUTH = 'S';
+    const LONGITUDE_EAST = 'E';
+    const LONGITUDE_WEST = 'W';
+
+    // PLAC tags
+    const PLACE_SEPARATOR       = ', ';
+    const PLACE_SEPARATOR_REGEX = ' *, *';
+
+    // SEX tags
+    const SEX_FEMALE  = 'F';
+    const SEX_MALE    = 'M';
+    const SEX_UNKNOWN = 'U';
+
+    /**
+     * Convert a GEDCOM tag to a canonical form.
+     *
+     * @param string $tag
+     *
+     * @return string
+     */
+    public function canonicalTag(string $tag): string
+    {
+        $tag = strtoupper($tag);
+
+        $tag = self::TAG_NAMES[$tag] ?? $tag;
+
+        return $tag;
+    }
+
+    /**
+     * @param string $tag
+     *
+     * @return bool
+     */
+    public function isUserDefinedTag(string $tag): bool
+    {
+        return substr($tag, 0, 1) === self::USER_DEFINED_TAG_PREFIX;
+    }
+
+    /**
+     * @param string $text
+     *
+     * @return float
+     */
+    public function readLatitude(string $text): float
+    {
+        return $this->readDegrees($text, self::LATITUDE_NORTH, self::LATITUDE_SOUTH);
+    }
+
+    /**
+     * @param string $text
+     *
+     * @return float
+     */
+    public function readLongitude(string $text): float
+    {
+        return $this->readDegrees($text, self::LONGITUDE_EAST, self::LONGITUDE_WEST);
+    }
+
+    /**
+     * @param string $text
+     * @param string $positive
+     * @param string $negative
+     *
+     * @return float
+     */
+    private function readDegrees(string $text, string $positive, string $negative): float
+    {
+        $text       = trim($text);
+        $hemisphere = substr($text, 0, 1);
+        $degrees    = substr($text, 1);
+
+        // Match a valid GEDCOM format
+        if (is_numeric($degrees)) {
+            $hemisphere = strtoupper($hemisphere);
+            $degrees    = (float) $degrees;
+
+            if ($hemisphere === $positive) {
+                return $degrees;
+            }
+
+            if ($hemisphere === $negative) {
+                return -$degrees;
+            }
+        }
+
+        // Just a number?
+        if (is_numeric($text)) {
+            return (float) $text;
+        }
+
+        // Can't match anything.
+        return 0.0;
+    }
+
+    /**
+     * @param float $latitude
+     *
+     * @return string
+     */
+    public function writeLatitude(float $latitude): string
+    {
+        return $this->writeDegrees($latitude, self::LATITUDE_NORTH, self::LATITUDE_SOUTH);
+    }
+
+    /**
+     * @param float $longitude
+     *
+     * @return string
+     */
+    public function writeLongitude(float $longitude): string
+    {
+        return $this->writeDegrees($longitude, self::LONGITUDE_EAST, self::LONGITUDE_WEST);
+    }
+
+    /**
+     * @param float  $degrees
+     * @param string $positive
+     * @param string $negative
+     *
+     * @return string
+     */
+    private function writeDegrees(float $degrees, string $positive, string $negative): string
+    {
+        if ($degrees < 0.0) {
+            return sprintf(self::DEGREE_FORMAT, $degrees, $negative);
+        }
+
+        return sprintf(self::DEGREE_FORMAT, $degrees, $positive);
+    }
+
+    /**
+     * Although empty placenames are valid "Town, , Country", it is only meaningful
+     * when structured places are used (PLAC:FORM town, county, country), and
+     * structured places are discouraged.
+     *
+     * @param string $text
+     *
+     * @return string[]
+     */
+    public function readPlace(string $text): array
+    {
+        $text = trim($text);
+
+        return preg_split(self::PLACE_SEPARATOR_REGEX, $text, PREG_SPLIT_NO_EMPTY);
+    }
+
+    /**
+     * @param string[] $place
+     *
+     * @return string
+     */
+    public function writePlace(array $place): string
+    {
+        return implode(self::PLACE_SEPARATOR, $place);
+    }
+
+    /**
+     * Some applications use non-standard values for unknown.
+     *
+     * @param string $text
+     *
+     * @return string
+     */
+    public function readSex(string $text): string
+    {
+        $text = strtoupper($text);
+
+        if ($text !== self::SEX_MALE && $text !== self::SEX_FEMALE) {
+            $text = self::SEX_UNKNOWN;
+        }
+
+        return $text;
+    }
+}