Adjust config.example.php for better international area code conversion

.dockerignore

@@ -0,0 +1,4 @@
+composer.lock
+config.cron
+config.php
+vendor/

.editorconfig

@@ -0,0 +1,15 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+# PHP PSR-2 Coding Standards
+# http://www.php-fig.org/psr/psr-2/
+
+root = true
+
+[*.php]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4

.gitignore

@@ -1 +1,17 @@
+/composer.lock
 /config.php
+/cards.xml
+/vendor/
+php-cs-fixer.config
+config.cron
+cache
+/carddav2fb.wiki
+/workbench/google.php
+/workbench/liz.php
+/workbench/request_b.php
+/workbench/request_m.php
+/workbench/t-online.php
+/workbench/test.php
+/workbench/test1.php
+/workbench/wolf_cfg.php
+/.vscode/launch.json

.php_cs.php

@@ -0,0 +1,14 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in('src')
+;
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setFinder($finder)
+    ->setUsingCache(false)
+;

.travis.yml

@@ -0,0 +1,56 @@
+sudo: false
+
+language: php
+
+php: 
+  - "7.3"
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+env:
+  global:
+    - secure: "Ef6Z9viGwbt8crRkwdjqfg3/xBwTvALrLBfTJJGsbYNbOq7g8amL6EMdlaUhjqLnQT+sHELtQIScpOp7XuVzt5t6yMbYh4zPBJ1MCjY1Fav859X44g42Ba8TzM3jlDSe95n2tq3kM9ExfIhBHIPwjn/Yfy32zhIFXmuDVbQKC4xW0/uD63kvnqA7H74/atNeyVTZu+ZrN05v9kRceLkb98QN2K/EOYZZcLikJDX98afVqI6IdQCjnpOlZ9DoSlODZ11xVPwdfo9wnlrf4RDhYR8MBOGGffQNigc2lIfHEwjOqh65+59TrL5YkdFtuti9dyKNXqvLK3SSUTjMsf1eQnpDoMuN1nS5kOTvPh0QpxrfotspuaUO5/hq2fmO/guvYFVVlShRrNYlMbVokzvk2NW5lohp8kENzntTyNRo+bmgP/GSM5a1Mg0uvpAMAirOUEWZUEatdJLsnokULv8Q8WlC5G59H5zdmzXeLNOh1LMWDUSFrn2M+JDkM8kmK34R6CRpSsxB1c+fJT711EDTl363TAqMvSrvlNgpyMXiNDmSjPIjfjD1sNsO7MkDrLjRj9nUxIaSRMmzW0MKr+Z/R/SCa2+ujY0o/pVZF8hr2UA0VWnji+b5RAiFwEKD5HM9RfeMe2O9rbdlas6I9pO38HOhli43bvvYVeqNq2evOoQ="
+    - secure: "ZN/wGrHvtcl01q6DUBlcvZZ49szNGgYbk8E4DZcc2T8dkNPITumnxhdYU+HoSFvvQm0w3KAIRTRj67EJxeHrKrxpnyJKtl03+iDcdVABP3rLFBy+9PHVgQ4oPEZ9qVqTdRP/z44CwjjR/NNXnSUTNtCIPjW5hnN4eM2YcugxQy8vTr8bwRoFkTrGDSgQhszg+bsjRan0PchJPnWmXnkqYR+lrHUIWcBr73/nwysdZQAX4BK9iUkETwJMNgw3Lgm4Q8QB8eNKoewZKnkjaJ+ykxudOtjXidRl7GxJpyUR6BzI2R6ba0Yf1B8lE+Fk/XuO9qFbZ/qu1Wv6F4AXuSiXcpmI/SVySj7+BN+Jha7Mbz9m2PRp4FXvRW4HxUNPJ168J+pWbzivpMSJ31Nt8MaxGtXedkVX1+j0g6p4hBueulRldJRKkifSFRqPq0z56KrFuSd9FHcpYEjile+wElutM2Fjw8+5QkP4kmaJd/zxHCE1P8tri3sljuWyl1yhKR2V87pY99hCtUp8H48pXBatUYK2pNOJho0f+rtwQIGjcQDAL96EVLXvNS4AW8tLZyUZC9hduSVrbPSxtHNdi8EDX/HJRifLI3sSMGW9ct3Tj5MfPo0MHc3okFh7nHCiCCQQGYEi8mWlLpm7DDgm6YXZo8h5UcOJcMbKAdh/IMm6oLQ="
+
+notifications:
+  email:
+    on_success: never
+    on_failure: change
+
+jobs:
+  include:
+    - stage: Test
+      install:
+        - composer install
+      script:
+        - vendor/bin/phpunit
+    - # parallel
+      install:
+        - rm -f ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini
+        - composer require --dev "phpstan/phpstan"
+      script:
+        - ./vendor/bin/phpstan analyze --level=5 --no-progress src
+    - # parallel
+      install:
+        - rm -f ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini
+        - composer require --dev "friendsofphp/php-cs-fixer:^2.8"
+      script:
+        - IFS=$'\n'; COMMIT_SCA_FILES=($(git diff --name-only --diff-filter=ACMRTUXB "${TRAVIS_COMMIT_RANGE}")); unset IFS
+        - ./vendor/bin/php-cs-fixer fix --config=.php_cs.php -v --dry-run --diff --stop-on-violation --using-cache=no --path-mode=intersection -- "${COMMIT_SCA_FILES[@]}"
+    - stage: Deploy
+      install: skip
+      script: skip
+      before_deploy:
+        - |
+            docker login -u $DOCKER_USER -p $DOCKER_PASS
+            docker pull ${TRAVIS_REPO_SLUG}:latest
+      deploy:
+        - provider: script
+          on:
+            branch: master
+          script: >
+            bash -c "set -xe &&
+            docker build --cache-from ${TRAVIS_REPO_SLUG}:latest -t ${TRAVIS_REPO_SLUG}:latest . &&
+            docker push ${TRAVIS_REPO_SLUG}:latest"

Dockerfile

@@ -0,0 +1,33 @@
+FROM alpine:3.12
+LABEL description="Download CardDAV VCards and upload as phonebook to AVM FRITZ!Box"
+
+VOLUME [ "/data" ]
+
+# Install dependencies for carddav2fb
+RUN set -xe && \
+    apk update && apk upgrade && \
+    apk add --no-cache --virtual=run-deps \
+        php7-cli \
+        php7-curl \
+        php7-dom \
+        php7-ftp \
+        php7-gd \
+        php7-mbstring \
+        php7-simplexml \
+        php7-tokenizer \
+        php7-xml \
+        php7-xmlreader \
+        php7-xmlwriter \
+        composer && \
+    apk del --progress --purge && \
+    rm -rf /var/cache/apk/*
+
+# Copy carddav2fb and install php dependencies
+COPY . /srv
+RUN mkdir -p /data && \
+    cd /srv && \
+    composer install --no-dev && \
+    chmod +x /srv/carddav2fb /srv/docker-entrypoint && \
+    ln -s /data/config.php .
+
+ENTRYPOINT [ "/srv/docker-entrypoint" ]

README.md

@@ -1,100 +1,124 @@
 # CardDAV contacts import for AVM FRITZ!Box
 
-[![Build Status](https://scrutinizer-ci.com/g/jens-maus/carddav2fb/badges/build.png?b=master)](https://scrutinizer-ci.com/g/jens-maus/carddav2fb/build-status/master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/jens-maus/carddav2fb/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/jens-maus/carddav2fb/?branch=master)
+[![Build Status](https://travis-ci.org/andig/carddav2fb.svg?branch=master)](https://travis-ci.org/andig/carddav2fb) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BB3W3WH7GVSNW)
 
-Features:
+This is a completely revised version of [https://github.com/jens-maus/carddav2fb][descent].
 
-* Allows to import CardDAV-based VCard contacts (e.g. from 'owncloud') to a phonebook in a AVM FRITZ!Box
-* CardDAV import includes photo images specified in VCards
-* No modification of FRITZ!Box firmware (aka FRITZ!OS) required
-* Definition of multiple CardDAV accounts and "folders" possible
-* Format of full name in FRITZ!Box phonebook can be designed
+## Features
 
-**CAUTION: This script will overwrite your current contacts in the FritzBox without any warning!**
+* download from any number of CardDAV servers
+* read from any local *.vcf files (optional)
+* selection (include/exclude) by categories or groups (e.g. iCloud)
+* upload of contact pictures to display them on the FRITZ!Fon (handling see below)
+* automatically preserves quickDial and vanity attributes of phone numbers set in FRITZ!Box Web GUI. Works without config.
+* automatically preserves internal numbers (e.g. if you use [Gruppenruf](https://avm.de/service/fritzbox/fritzbox-7590/wissensdatenbank/publication/show/1148_Interne-Rufgruppe-in-FRITZ-Box-einrichten-Gruppenruf/))
+* if more than nine phone numbers are included, the contact will be divided into a corresponding number of phonebook entries (any existing email addresses are assigned to the first set [there is no quantity limit!])
+* phone numbers are sorted by type. The order of the conversion values ('phoneTypes') determines the order in the phone book entry
+* the contact's UID of the CardDAV server is added to the phonebook entry (not visible in the FRITZ! Box GUI)
+* automatically preserves QuickDial and Vanity attributes of phone numbers set in FRITZ!Box Web GUI. Works without config. These data are saved separately in the internal FRITZ!Box memory under `../FRITZ/mediabox/Atrributes.csv` from loss.
+* generates an image with keypad and designated quickdial numbers (2-9), which can be uploaded to designated handhelds (see details below)
 
-## Information
+## Requirements
 
-This version of carddav2fb is a forked version from carlos22 (https://github.com/carlos22/carddav2fb) and adding support for convenient image upload, different FRITZ!Box base paths (for example for FRITZ!Box 7490 (UI) OS: 6.50) and full name design support. 
+* PHP 8.2 or higher (`apt-get install php php-curl php-mbstring php-xml`)
+* [Composer][composer]
+
+## Installation
 
-## Requirements
+Install requirements
 
-* PHP-version 5.3.6 or higher
-* PHP-curl module
-* PHP-ftp module
-* PHP-mbstring module
+```console
+git clone https://github.com/andig/carddav2fb.git
+cd carddav2fb
+composer install --no-dev
+```
 
-## Installation
+edit `config.example.php` and save as `config.php`
 
- Checkout the carddav2fb sources including its related subprojects using the following command:
+## Usage
 
-		git clone https://github.com/jens-maus/carddav2fb.git
+### List all commands
 
-Now you should have everything setup and checked out to a 'carddav2fb' directory.
+```console
+./carddav2fb list
+```
 
-### Configuration
-1. Make sure you have `System -> FRITZ!Box-Users -> Login via Username+Password` in your FRITZ!Box activated.
-2. Make sure you have a separate user created under `System -> FRITZ!Box-Users` for which the following access rights have been granted: 
-  * `FRITZ!Box settings` (required to upload telephone book data)
-  * `Access to NAS content` (required to upload photos via ftp).
-3. Make sure the telephone book you are going to update via carddav2fb exists on the FRITZ!Box, otherwise the upload will fail.
-4. Copy `config.example.php` to `config.php` and adapt it to your needs including setting the FRITZ!Box user settings.
+### Complete processing
 
-## Usage
+```console
+./carddav2fb run
+```
+
+### Get help for a command
+
+```console
+./carddav2fb run -h
+```
+
+#### Preconditions
 
-### Ubuntu
+* memory (USB stick) is indexed [Heimnetz -> Speicher (NAS) -> Speicher an der FRITZ!Box]
+* ftp access is active [Heimnetz -> Speicher (NAS) -> Heimnetzfreigabe]
+* you use an standalone user (NOT! dslf-config) which has explicit permissions for FRITZ!Box settings, access to NAS content and read/write permission to all available memory [System -> FRITZ!Box-Benutzer -> [user] -> Berechtigungen]
 
-1. Install PHP, PHP-curl, PHP-ftp, PHP-mbstring and php-xml module:
+### Upload FRITZ!Fon background image
 
-		sudo apt-get install php-cli php-curl php-ftp php-mbstring php-xml
+<img align="right" src="assets/fritzfon.png"/>
 
-2. Open a Terminal and execute:
+Using the `background-image` command it is possible to upload the quickdial numbers as background image to FRITZ!Fon (nothing else!)
 
-		php carddav2fb.php
+```console
+./carddav2fb background-image
+```
 
-### Windows
+Uploading can also be included in uploading phonebook:
 
-1. Download PHP from [php.net](http://windows.php.net/download/). Extract it to `C:\PHP`.
-2. Start -> cmd. Run `C:\PHP\php.exe C:\path\to\carddav2fb\carddav2fb.php`
+```console
+./carddav2fb run -i
+```
 
-## config.php Example (owncloud)
+#### Image upload preconditions
 
-	$config['fritzbox_ip'] = 'fritz.box';
-	$config['fritzbox_user'] = '<USERNAME>';
-	$config['fritzbox_pw'] = '<PASSWORD>';
-	$config['phonebook_number'] = '0';
-	$config['phonebook_name'] = 'Telefonbuch';
-	$config['fritzbox_path'] = 'file:///var/media/ftp/';
+* requires FRITZ!Fon C4 or C5 handhelds
+* settings in FRITZ!Fon: Einstellungen -> Anzeige -> Startbildschirme -> Klassisch -> Optionen -> Hintergrundbild
+* assignment is made via the internal number(s) of the handheld(s) in the 'fritzfons'-array in config.php
+* internal number have to be between '610' and '615', no '**'-prefix
 
-	// full name format options default 0
-	// parts in '' will only added if existing and switched to true in config
-	// 0 =  'Prefix' Lastname, Firstname, 'Additional Names', 'Suffix', 'orgname'
-	// 1 =  'Prefix' Firstname Lastname 'AdditionalNames' 'Suffix' '(orgname)'
-	// 2 =  'Prefix' Firstname 'AdditionalNames' Lastname 'Suffix' '(orgname)'
-	$config['fullname_format'] = 0;
+## Debugging
 
-	// fullname parts
-	$config['prefix'] = false; // include prefix in fullname if existing
-	$config['suffix'] = false; // include suffix in fullname if existing
-	$config['addnames'] = false; // include additionalnames in fullname if existing
-	$config['orgname'] = false; // include organisation (company) in fullname if existing
-
-	$config['quickdial_keyword'] = 'Quickdial:'; // once activated you may add 'Quickdial:+49030123456:**709' to the contact note field and the number will be set as quickdialnumber in your FRITZ!Box. It is possible to add more quickdials for one contact each in a new line
+For debugging please set your config.php to
 
-	// first
-	$config['carddav'][0] = array(
-	  'url' => 'https://<HOSTNAME>/remote.php/carddav/addressbooks/<USERNAME>/contacts',
-	  'user' => '<USERNAME>',
-	  'pw' => '<PASSWORD>'
-	);
+```php
+'http' => 'debug' => true
+```
 
-## Note
-This script is using third-party libraries for downloading VCards from CardDAV servers based on the following packages
-* CardDAV-PHP (https://github.com/jens-maus/CardDAV-PHP.git)
-* FRITZ!Box-API-PHP (https://github.com/jens-maus/fritzbox_api_php.git)
-* VCard-Parser (https://github.com/jens-maus/vCard-parser.git)
+## Docker image
+
+The Docker image contains the tool and all its dependencies. A volume
+`/data` contains the configuration files. If the configuration is
+missing, the Docker entrypoint will abort with an error message and copy
+an example file to the volume.
+
+There are two ways to use the image:
+
+```console
+docker run --rm -v ./carddav2fb-config:/data andig/carddav2fb command...
+```
+
+will execute a single command (and remove the created container
+afterwards).
+
+Without a command, the container entrypoint will enter an endless loop,
+repeatedly executing `carddav2fb run` in given intervals. This allows
+automatic, regular updates of your FRITZ!Box's phonebook.
 
 ## License
-This script is released under Public Domain.
+
+This script is released under Public Domain, some parts under GNU AGPL or MIT license. Make sure you understand which parts are which.
 
 ## Authors
-Copyright (c) 2012-2016 Karl Glatz, Martin Rost, Jens Maus, Johannes Freiburger
+
+Copyright (c) 2012-2025 Andreas Götz, Volker Püschel, Karl Glatz, Christian Putzke, Martin Rost, Jens Maus, Johannes Freiburger
+
+[composer]: https://getcomposer.org/download/
+[descent]: https://github.com/jens-maus/carddav2fb

carddav2fb

@@ -0,0 +1,20 @@
+#!/usr/bin/env php
+<?php
+
+namespace Andig;
+
+use Symfony\Component\Console\Application;
+
+require_once('vendor/autoload.php');
+
+$app = new Application('CardDAV to FritzBox converter');
+
+$app->addCommands(array(
+    new RunCommand(),
+    new DownloadCommand(),
+    new ConvertCommand(),
+    new UploadCommand(),
+    new BackgroundCommand()
+));
+
+$app->run();