diff --git a/README.md b/README.md index 75ec6536..7381b5c8 100644 --- a/README.md +++ b/README.md @@ -1,250 +1,144 @@ -# Starface Kontakt-Sync - Outlook Add-in +# Starface Kontakt-Sync -Outlook Add-in zur bidirektionalen Synchronisation von Kontakten zwischen Microsoft Outlook und einer Starface Telefonanlage. +Windows-Anwendung zur bidirektionalen Synchronisation von Kontakten zwischen Microsoft Outlook und einer Starface Telefonanlage. ## Funktionen - **Bidirektionale Synchronisation** von Kontakten zwischen Outlook und Starface -- **Profil-System** zum Verwalten mehrerer Sync-Konfigurationen (z.B. verschiedene Adressbücher oder Anlagen) -- **Starface-Adressbücher**: Zentrales Adressbuch, persönliches Adressbuch und Tag-basierte Adressbücher -- **Outlook-Kontaktordner**: Frei wählbarer Kontaktordner als Sync-Ziel -- **Sync-Richtung** konfigurierbar: Outlook → Starface, Starface → Outlook oder bidirektional +- **Profil-System** zum Verwalten mehrerer Sync-Konfigurationen (verschiedene Adressbuecher oder Anlagen) +- **Starface-Adressbuecher**: Zentrales Adressbuch, persoenliches Adressbuch und Tag-basierte Adressbuecher +- **Outlook-Kontaktordner**: Frei waehlbarer Kontaktordner als Sync-Ziel +- **Sync-Richtung** konfigurierbar: Outlook -> Starface, Starface -> Outlook oder bidirektional - **Intelligentes Matching**: Kontakte werden anhand von E-Mail-Adresse oder Name abgeglichen -- **Änderungserkennung**: Nur geänderte Kontakte werden übertragen (Hash-basiert) -- **Kompatibel** mit Outlook Classic und dem neuen Outlook (Office Web Add-in) -- **Einfacher Installer** mit automatischer Zertifikatskonfiguration +- **Aenderungserkennung**: Nur geaenderte Kontakte werden uebertragen (Hash-basiert) +- **Auto-Sync**: Optionaler automatischer Sync in konfigurierbarem Intervall +- **System Tray**: Laeuft im Hintergrund, Schnell-Sync per Rechtsklick +- **Kompatibel** mit Outlook Classic und dem neuen Outlook +- **Komplett lokal**: Kein Exchange, kein Microsoft 365, kein Cloud-Konto erforderlich ## Voraussetzungen -- [Node.js](https://nodejs.org/) ab Version 18 (LTS empfohlen) -- npm (wird mit Node.js mitgeliefert) -- Microsoft Outlook (Classic oder Neu) +- Windows 10/11 +- .NET Framework 4.8 (in Windows 10/11 bereits enthalten) +- Microsoft Outlook (Classic oder Neu, beliebige Version) - Starface Telefonanlage ab Version 6.7 (REST-API) -- Windows 10/11 (für den Installer) ## Installation beim Kunden -### Schnellinstallation (empfohlen) +### Setup ausfuehren -Der Installer richtet alles automatisch ein: Zertifikate, lokaler Webserver, Outlook-Registrierung. - -**Schritt 1: Add-in bauen (einmalig, auf dem Entwickler-PC)** - -```bash -npm install -npm run build -``` - -**Schritt 2: Installer-Paket zum Kunden mitnehmen** - -Folgende Dateien/Ordner werden benötigt: - -``` -installer/ -├── setup.ps1 # Installations-Script -├── uninstall.ps1 # Deinstallations-Script -├── local-server.js # Lokaler HTTPS-Webserver -dist/ # Build-Ausgabe (von Schritt 1) -``` - -**Schritt 3: Beim Kunden ausführen (als Administrator)** - -```powershell -# PowerShell als Administrator öffnen, dann: -Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -.\installer\setup.ps1 -``` - -Das Setup fragt interaktiv ab: - -| Abfrage | Beispiel | Beschreibung | -|---------|----------|--------------| -| Starface Host/IP | `192.168.1.100` | IP-Adresse oder Hostname der Starface (nur für Zertifikat-Import) | -| Starface HTTPS-Port | `443` | Standard: 443 | -| Lokaler Port | `444` | Port für den lokalen Webserver (Standard: 444) | - -> **Hinweis:** Login-Daten werden beim Setup nicht benötigt. Diese werden später im Add-in selbst in den Sync-Profilen konfiguriert. - -### Was macht das Setup? - -1. **Starface-Zertifikat importieren** - Verbindet sich zur Starface, extrahiert das SSL-Zertifikat und importiert es als vertrauenswürdig in den Windows-Zertifikatspeicher. Damit funktionieren die API-Aufrufe vom Add-in zur Starface. - -2. **Lokale Zertifikate erstellen** - Erstellt eine lokale CA und ein davon signiertes localhost-Zertifikat. Die CA wird als vertrauenswürdig importiert. Damit läuft der lokale Webserver mit gültigem HTTPS. - -3. **Lokalen Webserver einrichten** - Installiert einen minimalen Node.js HTTPS-Server als Windows Scheduled Task. Der Server startet automatisch beim Systemstart und liefert nur die statischen Add-in Dateien über `https://localhost:444` aus. - -4. **Outlook Add-in registrieren** - Registriert das Add-in automatisch für Outlook Classic (per Registry). Für das neue Outlook wird eine Anleitung zur manuellen Einrichtung angezeigt. +1. `StarfaceOutlookSync_Setup_0.0.0.1.exe` ausfuehren +2. Installationsoptionen waehlen: + - Desktop-Verknuepfung erstellen (optional) + - Bei Windows-Anmeldung automatisch starten (empfohlen) +3. Fertig - die App startet automatisch ### Nach der Installation -- **Outlook Classic**: Outlook neu starten. Im Ribbon erscheint der Button **"Kontakt-Sync"** in der Gruppe "Starface Sync". -- **Neues Outlook**: Manuell hinzufügen über Einstellungen → Add-Ins verwalten → Benutzerdefinierte Add-Ins → Aus Datei hinzufügen → `C:\Program Files\StarfaceOutlookSync\manifest-catalog\manifest.xml` +1. App starten (Tray-Icon oder Desktop-Verknuepfung) +2. "Neues Profil" klicken +3. Starface-Verbindungsdaten eingeben (Host, Login-ID, Kennwort) +4. "Verbindung testen" und "Adressbuecher laden" +5. Starface-Adressbuch und Outlook-Kontaktordner waehlen +6. Speichern und "Jetzt synchronisieren" ### Deinstallation -```powershell -# PowerShell als Administrator: -Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -.\uninstall.ps1 -# oder direkt aus dem Installationsverzeichnis: -& "C:\Program Files\StarfaceOutlookSync\uninstall.ps1" -``` - -Die Deinstallation entfernt: -- Den lokalen Webserver (Scheduled Task) -- Die lokale CA und das localhost-Zertifikat -- Die Outlook-Registrierung -- Alle installierten Dateien - -Das Starface-Zertifikat wird **nicht** entfernt, da es ggf. von anderen Anwendungen benötigt wird. - -### Weitere Starface-Anlagen hinzufügen - -Wenn im Add-in ein Sync-Profil zu einer weiteren Starface-Anlage eingerichtet wird, deren Zertifikat noch nicht importiert ist, schlägt der Verbindungstest fehl. Das Add-in zeigt dann einen entsprechenden Hinweis an. - -Um das Zertifikat einer weiteren Anlage zu importieren: - -```powershell -# PowerShell als Administrator: -cd "C:\Program Files\StarfaceOutlookSync" -.\import-cert.ps1 -StarfaceHost 192.168.2.200 -# oder mit anderem Port: -.\import-cert.ps1 -StarfaceHost pbx2.firma.local -Port 8443 -``` - -Danach funktioniert die Verbindung im Add-in sofort - kein Neustart nötig. +Ueber Windows Einstellungen -> Apps oder die Systemsteuerung. +Benutzerdaten (Profile, Mappings) werden mit entfernt. ## Entwicklung -### Dependencies installieren +### Bauen ```bash -npm install +# In Visual Studio oeffnen und bauen, oder: +dotnet build src/StarfaceOutlookSync/StarfaceOutlookSync.csproj -c Release ``` -### Development Server starten +### Installer erstellen -```bash -npm run dev -``` - -Startet einen lokalen HTTPS-Server auf `https://localhost:3000` mit einem Dev-Zertifikat (nur für Entwicklung). - -### Production Build - -```bash -npm run build -``` - -Die fertigen Dateien liegen anschließend im Ordner `dist/`. - -### Manuelles Sideloading (zum Testen) - -1. `npm run dev` starten -2. In Outlook: Datei → Add-Ins verwalten → Meine Add-Ins → "Benutzerdefiniertes Add-In hinzufügen" → `manifest.xml` auswählen - -## Benutzung - -1. In Outlook auf den Button **"Kontakt-Sync"** in der Ribbon-Leiste klicken -2. Ein neues Sync-Profil anlegen: - - **Profilname** vergeben (z.B. "Firmenkontakte Hauptanlage") - - **Starface-Verbindung** konfigurieren: Host/IP, Port, Login-ID und Kennwort eingeben - - **Verbindung testen** um die Zugangsdaten zu prüfen - - **Adressbücher laden** um die verfügbaren Starface-Adressbücher abzurufen - - **Starface-Adressbuch** auswählen (Zentral, Persönlich oder Tag) - - **Outlook-Kontaktordner** auswählen - - **Synchronisationsrichtung** festlegen -3. Profil speichern -4. Über "Jetzt synchronisieren" die Kontakte abgleichen - -Es können beliebig viele Profile angelegt werden, auch für unterschiedliche Starface-Anlagen. +1. [Inno Setup 6](https://jrsoftware.org/isinfo.php) installieren +2. Release-Build erstellen +3. `installer/setup.iss` in Inno Setup oeffnen und kompilieren +4. Setup-EXE wird in `dist/` erstellt ## Projektstruktur ``` outlook-sync/ -├── manifest.xml # Office Add-in Manifest -├── package.json # Dependencies & Scripts -├── webpack.config.js # Build-Konfiguration -├── assets/ # Add-in Icons -├── dist/ # Build-Ausgabe +├��─ StarfaceOutlookSync.sln # Visual Studio Solution ├── installer/ -│ ├── setup.ps1 # Installations-Script -│ ├── uninstall.ps1 # Deinstallations-Script -│ ├── import-cert.ps1 # Zertifikat-Import für weitere Anlagen -│ └── local-server.js # Lokaler HTTPS-Webserver -└── src/ - ├── models/ - │ └── types.ts # Datenmodelle - ├── services/ - │ ├── starface-api.ts # Starface REST API Client - │ ├── outlook-contacts.ts # Outlook REST API Client - │ ├── sync-engine.ts # Sync-Logik - │ └── profile-manager.ts # Profilverwaltung - └── taskpane/ - ├── index.tsx # Entry Point - ├── taskpane.html # HTML Template - ├── styles/taskpane.css # Styling - └── components/ - ├── App.tsx # Hauptkomponente - ├── ProfileList.tsx # Profilübersicht - ├── ProfileEditor.tsx # Profil-Editor - └── SyncView.tsx # Sync-Ansicht +│ └── setup.iss # Inno Setup Script +└── src/StarfaceOutlookSync/ + ├── StarfaceOutlookSync.csproj # Projektdatei + ├── Program.cs # Entry Point (Single Instance) + ├── Models/ + │ ├── UnifiedContact.cs # Kontakt-Datenmodell + │ └── SyncProfile.cs # Profile, Mappings, Ergebnisse + ├── Services/ + │ ├── StarfaceApiClient.cs # Starface REST-API Client + │ ├── OutlookContactsService.cs # Outlook COM Interop + │ ├── ProfileManager.cs # Profilverwaltung (AppData) + │ └── SyncEngine.cs # Bidirektionale Sync-Logik + └── UI/ + ├── MainForm.cs # Hauptfenster + System Tray + ├── ProfileEditorForm.cs # Profil anlegen/bearbeiten + ├── SyncProgressForm.cs # Sync-Fortschritt mit Log + └── AboutForm.cs # Info-Dialog ``` ## Synchronisierte Kontaktfelder -| Feld | Outlook | Starface | -|------|---------|----------| -| Vorname | GivenName | NAME | -| Nachname | Surname | SURNAME | +| Feld | Outlook (COM) | Starface (REST) | +|------|---------------|-----------------| +| Vorname | FirstName | NAME | +| Nachname | LastName | SURNAME | | Firma | CompanyName | COMPANY | | Position | JobTitle | JOB_TITLE | -| E-Mail | EmailAddresses | EMAIL | -| Telefon (Büro) | Business Phone | OFFICE_PHONE_NUMBER | -| Mobiltelefon | Mobile Phone | MOBILE_PHONE_NUMBER | -| Telefon (Privat) | Home Phone | PRIVATE_PHONE_NUMBER | -| Fax | Business Fax | FAX_NUMBER | -| Straße | Street | STREET | -| Stadt | City | CITY | -| PLZ | PostalCode | POSTAL_CODE | -| Bundesland | State | STATE | -| Land | CountryOrRegion | COUNTRY | -| Webseite | Websites | URL | -| Notizen | PersonalNotes | NOTE | +| E-Mail | Email1Address | EMAIL | +| Telefon (Buero) | BusinessTelephoneNumber | OFFICE_PHONE_NUMBER | +| Mobiltelefon | MobileTelephoneNumber | MOBILE_PHONE_NUMBER | +| Telefon (Privat) | HomeTelephoneNumber | PRIVATE_PHONE_NUMBER | +| Fax | BusinessFaxNumber | FAX_NUMBER | +| Strasse | BusinessAddressStreet | STREET | +| Stadt | BusinessAddressCity | CITY | +| PLZ | BusinessAddressPostalCode | POSTAL_CODE | +| Bundesland | BusinessAddressState | STATE | +| Land | BusinessAddressCountry | COUNTRY | +| Webseite | WebPage | URL | +| Notizen | Body | NOTE | | Anrede | Title | SALUTATION | -| Titel | — | TITLE | | Geburtstag | Birthday | BIRTHDAY | ## Technische Details ### Architektur -Das Add-in ist ein Office Web Add-in (funktioniert in Classic und New Outlook). Outlook lädt das Add-in als Webseite in einem eingebetteten Browser (WebView). Die Webseite kommuniziert dann direkt mit der Starface REST-API und der Outlook REST-API: +Die Anwendung ist eine native Windows-App (WinForms, .NET Framework 4.8). Sie greift direkt per COM Interop auf Outlook-Kontakte zu und kommuniziert per REST-API mit der Starface. Kein Webserver, kein Browser, kein Exchange erforderlich. ``` -Outlook - └── WebView (eingebetteter Browser) - ├── Lädt UI von: https://localhost:444 (lokaler Webserver) - ├── Spricht direkt mit: Starface REST-API - └── Spricht direkt mit: Outlook REST-API (Office.js) +StarfaceOutlookSync.exe + ├── COM Interop -> Outlook Kontakte (lokal) + ├── REST-API -> Starface Telefonanlage (HTTPS) + └── Dateisystem -> Profile & Mappings (%AppData%) ``` -### Zertifikate - -Der lokale Webserver und die Starface verwenden HTTPS. Da die Starface typischerweise ein self-signed Zertifikat hat und der lokale Webserver ebenfalls ein lokales Zertifikat braucht, erstellt das Setup: - -- Importiert das **Starface-Zertifikat** in den Windows Trusted Root Store → Outlook/WebView vertraut den API-Aufrufen zur Starface -- Erstellt eine **lokale CA** → wird in den Trusted Root Store importiert -- Erstellt ein **localhost-Zertifikat**, signiert von der lokalen CA → der lokale Webserver hat gültiges HTTPS - ### Datenspeicherung -- **Sync-Profile**: `localStorage` im Outlook WebView -- **Sync-Mappings**: `localStorage` im Outlook WebView (Zuordnung Outlook-ID ↔ Starface-ID) -- **Server-Konfiguration**: `C:\Program Files\StarfaceOutlookSync\config.json` -- **Zugangsdaten**: Werden nur im Add-in (localStorage) gespeichert, nicht auf dem Dateisystem +Alle Daten werden lokal pro Benutzer gespeichert: +- `%AppData%\StarfaceOutlookSync\profiles.json` - Sync-Profile mit Zugangsdaten +- `%AppData%\StarfaceOutlookSync\mappings\` - Kontakt-Zuordnungen pro Profil + +### SSL-Zertifikate + +Self-signed Zertifikate der Starface werden automatisch akzeptiert. Es ist kein manueller Zertifikat-Import erforderlich. ## Lizenz -Proprietär - Alle Rechte vorbehalten. +Proprietaer - Alle Rechte vorbehalten. + +HackerSoft - Hacker-Net Telekommunikation +Stefan Hacker +Am Wunderburgpark 5b +26135 Oldenburg diff --git a/StarfaceOutlookSync.sln b/StarfaceOutlookSync.sln new file mode 100644 index 00000000..ece310a4 --- /dev/null +++ b/StarfaceOutlookSync.sln @@ -0,0 +1,19 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "StarfaceOutlookSync", "src\StarfaceOutlookSync\StarfaceOutlookSync.csproj", "{A1B2C3D4-E5F6-7890-ABCD-EF1234567890}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A1B2C3D4-E5F6-7890-ABCD-EF1234567890}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/assets/icon-128.png b/assets/icon-128.png deleted file mode 100644 index 5ca10879..00000000 Binary files a/assets/icon-128.png and /dev/null differ diff --git a/assets/icon-16.png b/assets/icon-16.png deleted file mode 100644 index 20235b53..00000000 Binary files a/assets/icon-16.png and /dev/null differ diff --git a/assets/icon-32.png b/assets/icon-32.png deleted file mode 100644 index 3f6b50dd..00000000 Binary files a/assets/icon-32.png and /dev/null differ diff --git a/assets/icon-64.png b/assets/icon-64.png deleted file mode 100644 index 8055a7c9..00000000 Binary files a/assets/icon-64.png and /dev/null differ diff --git a/assets/icon-80.png b/assets/icon-80.png deleted file mode 100644 index a4b34b41..00000000 Binary files a/assets/icon-80.png and /dev/null differ diff --git a/dist/assets/icon-128.png b/dist/assets/icon-128.png deleted file mode 100644 index 5ca10879..00000000 Binary files a/dist/assets/icon-128.png and /dev/null differ diff --git a/dist/assets/icon-16.png b/dist/assets/icon-16.png deleted file mode 100644 index 20235b53..00000000 Binary files a/dist/assets/icon-16.png and /dev/null differ diff --git a/dist/assets/icon-32.png b/dist/assets/icon-32.png deleted file mode 100644 index 3f6b50dd..00000000 Binary files a/dist/assets/icon-32.png and /dev/null differ diff --git a/dist/assets/icon-64.png b/dist/assets/icon-64.png deleted file mode 100644 index 8055a7c9..00000000 Binary files a/dist/assets/icon-64.png and /dev/null differ diff --git a/dist/assets/icon-80.png b/dist/assets/icon-80.png deleted file mode 100644 index a4b34b41..00000000 Binary files a/dist/assets/icon-80.png and /dev/null differ diff --git a/dist/manifest.xml b/dist/manifest.xml deleted file mode 100644 index 2a2a3f6e..00000000 --- a/dist/manifest.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - a1b2c3d4-e5f6-7890-abcd-ef1234567890 - 1.0.0.0 - Starface Outlook Sync - de-DE - - - - - - - - https://localhost:3000 - - - - - - - - - - - - - -
- - - 450 - -
- - - ReadWriteMailbox - - - - - - false - - - - - - - - - - - - - - - - -