Modifica di WooCommerce ESW

== WooCommerce ESW ==
Il progetto prevede la creazione di un mini-sito con commerce integrato con Easy Store Web.

=== Ambiente di lavoro ===
==== Container ====
Abbiamo optato per un docker container così strutturato<br/>
<code>docker-compose.yml</code>
<syntaxhighlight lang="yaml">
version: '3.9'

services:

  db:
    image: mysql:5.7
    ports:
      - 3306:3306
    environment:
      MYSQL_DATABASE: webmobili
      MYSQL_USER: webmobili
      MYSQL_PASSWORD: w3bm0b1l1
      MYSQL_ROOT_PASSWORD: w3bm0b1l1
    volumes:
      - db:/var/lib/mysql

  wordpress:
    depends_on:
      - db
    build:
      context: ./
    ports:
      - 8000:80
    environment:
      WORDPRESS_DB_HOST: db
      WORDPRESS_DB_USER: webmobili
      WORDPRESS_DB_PASSWORD: w3bm0b1l1
      WORDPRESS_DB_NAME: webmobili
      WORDPRESS_DEBUG: 1
      TZ: "Europe/Rome"
    volumes:
      - wordpress:/var/www/html

volumes:
  db:
  wordpress:
</syntaxhighlight>
Punta al seguente '''Dockerfile''' che si occupa di configurare '''xdebug''' per PHP.<br/>
'''N.B.''' Ad oggi (giugno 2022) Wordpress non è compatibile con PHP 8 (infatti usiamo il 7.4).
<syntaxhighlight lang="docker">
FROM wordpress:6.0.2-php7.4-apache
RUN apt-get update && \
  pecl install xdebug \
  && docker-php-ext-enable xdebug
# Copy xdebug.ini to /usr/local/etc/php/conf.d/
COPY ./*.ini /usr/local/etc/php/conf.d/
# Copy plugin data to to /usr/src/wordpress/wp-content/plugins/designbest-esw
COPY --chown=www-data:www-data ./designbest-esw/ /usr/src/wordpress/wp-content/plugins/designbest-esw/
</syntaxhighlight>
Nella root dev'essere presente il file <code>xdebug.ini</code> così configurato:
<syntaxhighlight lang="bash">
zend_extension=xdebug.so

[xdebug]
xdebug.mode=develop,debug
xdebug.discover_client_host = true
xdebug.start_with_request=yes

</syntaxhighlight>

Ecco il '''devcontainer.json'''
<syntaxhighlight lang="json">
{
	"name": "Designbest Commerce ESW",

	// Update the 'dockerComposeFile' list if you have more compose files or use different names.
	// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
	"dockerComposeFile": [
		"../docker-compose.yml"
	],

	// The 'service' property is the name of the service for the container that VS Code should
	// use. Update this value and .devcontainer/docker-compose.yml to the real service name.
	"service": "wordpress",

	// The optional 'workspaceFolder' property is the path VS Code should open by default when
	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
	"workspaceFolder": "/var/www/html",

	// Add the IDs of extensions you want installed when the container is created.
	"extensions": ["xdebug.php-pack", "xdebug.php-debug", "bmewburn.vscode-intelephense-client","neilbrayfield.php-docblocker"],

	// Use 'forwardPorts' to make a list of ports inside the container available locally.
	"forwardPorts": [8000]
}
</syntaxhighlight>

==== Visual Studio ====
- Cliccare sul pulsante '''Run & Debug''' e farsi creare in automatico il file <code>.vscode/launch.json</code> per abilitare xdebug per PHP.<br/>
- Creare un file <code>.vscode/settings.json</code> per configurare le estensioni col seguente codice
<syntaxhighlight lang="json">
{
  "es6-css-minify.minifyOnSave": "exists",
  "intelephense.environment.phpVersion": "7.4.3"
}
</syntaxhighlight>

- Aprire <code>wp-config.php</code> e aggiungere appena sotto a <code>define( 'WP_DEBUG',...</code> la riga
<syntaxhighlight lang="bash">define( 'WP_DEBUG_LOG', true );</syntaxhighlight>

==== Wordpress Admin ====
Da <code>http://localhost:8000/wp-admin</code><br/>
ho creato credenziali con la mia solita password, utente la mail di lavoro.
* Aggiornare l'aggiornabile
* Installare il plugin '''WooCommerce'''
* ''(opzionale)'' Installare il tema '''Astra'''
** ''Aspetto'' => ''Opzioni Astra'' => spalla dx => ''Installa Plugin Importatore''
** Da questa pagina installare il template (scegliendo ''Elementor'') '''Custom Printing''' con tutti i suoi contenuti
* ''(opzionale)'' Installare il plugin '''Classic Widget'''
* <del>Installare il plugin '''Checkout Field Editor for WooCommerce'''.</del><br/> <del>Entrare nelle impostazioni e aggiungere i campi ''partita iva'' e ''codice fiscale'' con i nomi <code>billing_cf</code> e <code>billing_piva</code></del>
* ''(developer)'' Installare il plugin '''WP Crontrol''' per vedere la situazione dei ''cron jobs'' e poterli eliminare
* ''(developer)'' Installare il plugin '''WP Hooks Finder''' (by Muhammad Rehman) per poter vedere tutti gli hook in pagina.

=== Easy Store - Le specifiche ===
Ci saranno '''3 tipi di utenza'''
* Clienti con '''Easy Store'''
* Clienti con '''Outlet'''
* Clienti con '''Easy Store + Outlet'''

Il plugin è in grado di distinguere in quale caso ci troviamo in base al file di configurazione<br/>
<code>/designbest-esw/config/config.php</code><br/>
Dalla voce 
<syntaxhighlight lang="php">
"sorgente-dati" => "designbest", // valori esw o designbest o designbest-esw
</syntaxhighlight>

Il plugin è basato su 5 interfacce ''services'' che cambiano le loro funzioni a seconda del tipo di utenza:
* '''<code>IApiConnectService</code>''' connessione alle API
* '''<code>IProductsService</code>''' sincronizzazione prodotti
* '''<code>IOrdersService</code>''' gestione degli ordini (fattura ecc)
* '''<code>IAdminService</code>''' gestione backoffice WP
* '''<code>ICronJobsService</code>''' gestione di cron-job per sincronizzare
<br/>

==== Clienti con Easy Store ====
File <code>config.php</code> correttamente configurato per questa utenza:
<syntaxhighlight lang="php">
return array(
  "sorgente-dati" => "esw",
  "environment" => "test", // "production"

  // Configurazione esw
  "esw_api-endpoint" => "https://easyapitest.eswportal.it", // https://easyapi6.eswportal.it
  "esw_negoziocode" => "01",
  "esw-x-apikey" => "hEckyjWBYUycOIRiUZUgJUJ4YWJHWlY4N1VTTWYwM2NRZUZOSmc=",
  "esw-dbconnection" => "173_WMECOMMERCE",
  "esw-codicemagazzino" => "MAG"
);
</syntaxhighlight>

Le API di Easy Store non permettono di caricare articoli sul gestionale, ma solo di leggerli.<br/>
Per ''tenere sincronizzati'' i prodotti è necessario montare un pooling tramite un ''cron-job'' che andrà a leggere i dati del gestionale e li proietterà sul commerce.<br/>
Aggiunta funzione per caricare un elenco pre-compilato di categorie in quanto EasyStore non le considera.<br/><br/>

'''<code>IApiConnectService</code>''' permette la connessione alle API di Easy Store<br/>
:https://easyapitest.eswportal.it/developer/index<br/><br/>

'''<code>IProductsService</code>''' mette a disposizione
:* <code>createBrandTaxonomy()</code> che si occupa di aggiungere la tassonomia del ''manufacturer'' che stranamente in WooCommerce non è presente.<br/>
:<del>Oltre a questo inserisce un elenco convenzionato di ''categories'' perché Easy Store non ha i dati sulle categorie/tipologie di prodotto.</del>
:* <code>allProductsSync()</code> Legge tutti i prodotti del negozio specificato in <code>config.php</code> che hanno il flag ''commerce'' e li sincronizza con WooCommerce.<br/>
:Se sono già presenti si limita ad aggiornare solo i campi ''prezzo'' e ''giacenza''. Altrimenti inserisce l'intero prodotto.<br/>
:I dati sincronizzati non hanno dati sufficienti per una pubblicazione (mancano titolo, descrizione e immagini) e saranno importati come ''bozze''.
:* <code>insertDefaultCategories()</code> Inserisce gli ambienti default per definire una lista di partenza.
: Il pulsante si trova nell'admin
<br/><br/>

'''<code>IOrdersService</code>''' gestisce l'acquisto sincronizzando tutto col gestionale.
:* <code>customCheckoutFields()</code> Aggiunge ''codice fiscale'' e ''partita I.V.A.'' ai campi di checkout del carrello.
:* <code>newOrder()</code> spedisce a Easy Store tutte le informazioni sull'acquisto.
: Si occupa di registrare l'anagrafica e il prodotto venduto tramite i corrispondenti endpoint post <code>anagrafica</code> e post <code>vendite</code>.<br/>
:In queste chiamate alcuni parametri sono costanti definite durante la progettazione.
::* <code>codice_venditore = ONL49554</code>
::* <code>tipo_fattura = FT</code>
::* <code>codice_fornitore</code> viene passato se è definito, in caso contrario passa <code>ECOMMERCE</code>
::* <code>codice_magazzino = MAG</code> ora proviene dalla configurazione
::* <code>prezzo_forzato = "True"</code> utilizzare i valori ''"True"'' o ''"False"'' per i booleani
<br/><br/>

'''<code>IAdminService</code>''' gestisce le pagine di backoffice e le loro logiche lato server.<br/>
:Piazza l'elemento nel menu con l'icona adeguata, mette a disposizione una pagina che riassume le caratteristiche del plugin e permette una sincronizzazione manuale premendo un pulsante.<br/><br/>

'''<code>ICronJobsService</code>''' Attiva (e predispone la disattivazione) di un ''cron job'' che chiama la sincronizzazione dei prodotti ( <code>IProductsService::allProductsSync()</code> ) tutti i giorni a partire dalle 8 per 2 volte al giorno.<br/><br/>

==== Clienti con outlet ====
File <code>config.php</code> correttamente configurato per questa utenza:
<syntaxhighlight lang="php">
return array(
  "sorgente-dati" => "designbest",
  "environment" => "test", // "production",

  // Configurazione designbest
  "db-token_endpoint" => "https://ws.designbest.com/token",
  "db-token_username" => "designbestrest",
  "db-token_password" => "Z3+3MlGwEbz#",
  "db-shop_piva" => "00258570274"  // Arredamenti Casabella
);
</syntaxhighlight>

Il database di Designbest ha dei dati più completi rispetto a ESW per un e-commerce.<br/>
Allo stesso modo, il meccanismo di sincronizzazione porterà i dati dal database di Designbest a quello del commerce locale.<br/><br/>

'''<code>IApiConnectService</code>''' permette la connessione alle API di Designbest<br/>
:https://ws.designbest.com/doc/index<br/><br/>

'''<code>IProductsService</code>''' mette a disposizione
:* <code>createBrandTaxonomy()</code> che si occupa di aggiungere la tassonomia del ''manufacturer'' che stranamente in WooCommerce non è presente.<br/>
:Non si occupa di aggiungere ''categories'' al pool di base perché i prodotti Designbest forniscono la precisa tipologia.
:* <code>allProductsSync()</code> Legge tutti i prodotti del negozio specificato in <code>config.php</code> che hanno il flag ''e-commerce approved'' e li sincronizza con WooCommerce.<br/>
:Se sono già presenti si limita ad aggiornare solo i campi ''prezzo'' e ''giacenza''. Altrimenti inserisce l'intero prodotto.<br/>
:I dati sincronizzati saranno importati come ''bozze''.<br/><br/>

'''<code>IOrdersService</code>''' gestisce l'acquisto sincronizzando tutto col gestionale.
:* <code>customCheckoutFields()</code> Aggiunge ''codice fiscale'' e ''partita I.V.A.'' ai campi di checkout del carrello.
:* <code>newOrder()</code> comunica a Designbest la diminuzione della giacenza dell'articolo (non implementato in quanto sovrascritto dalla sincronizzazione programmata).<br/>
<br/>

'''<code>IAdminService</code>''' gestisce le pagine di backoffice e le loro logiche lato server.<br/>
:Piazza l'elemento nel menu con l'icona adeguata, mette a disposizione una pagina che riassume le caratteristiche del plugin e permette una sincronizzazione manuale premendo un pulsante.<br/><br/>

'''<code>ICronJobsService</code>''' Attiva (e predispone la disattivazione) di un ''cron job'' che chiama la sincronizzazione dei prodotti ( <code>IProductsService::allProductsSync()</code> ) tutti i giorni a partire dalle 8 per 2 volte al giorno.<br/><br/>

==== Clienti con Outlet + Easy Store ====
File <code>config.php</code> correttamente configurato per questa utenza:
<syntaxhighlight lang="php">
return array(
  "sorgente-dati" => "designbest-esw",
  "environment" => "test", // "production"

  // Configurazione esw
  "esw_negoziocode" => "01",  // Arredamenti Casabella su Esw
  "esw-x-apikey" => "hEckyjWBYUycOIRiUZUgJUJ4YWJHWlY4N1VTTWYwM2NRZUZOSmc=",
  "esw-dbconnection" => "173_WMECOMMERCE",
  // Configurazione designbest
  "db-token_endpoint" => "https://ws.designbest.com/token",
  "db-token_username" => "designbestrest",
  "db-token_password" => "Z3+3MlGwEbz#",
  "db-shop_piva" => "00258570274"  // Arredamenti Casabella su Outlet
);
</syntaxhighlight>

I ''services'' dovranno comportarsi in parte come Esw e in parte come Outlet.<br/>
Importante che nella configurazione si specifichi la stessa entità con i 2 diversi identificativi (es. Casabella Arredamenti su ESW e lo stesso su Outlet).

=== Attivazione plugin ===
Qui i passaggi per attivare il plugin sul sito wordpress del cliente.<br/>
Innanzitutto bisogna recuperare dal '''cliente'''
* Credenziali per accedere a <code>wp-admin</code>
* Credenziali per accedere a <code>FTP</code>
Poi bisogna farsi dare da '''Sintesys'''
* <code>api-endpoint</code>
* <code>negozio_code</code>
* <code>x-apikey</code>
* <code>dbconnection</code>
* <code>codice_magazzino</code><br/>

Una volta che si hanno tutti i dati.
* Installare (se non presente) il plugin dipendenza '''WooCommerce'''
* Copiare su FTP il folder del plugin nella cartella <code>/wp-content/plugins</code>
* Attivare il plugin tramite l'apposita sezione della dashboard
* (opzionale) installare il plugin '''WP Crontrol''' per vedere i cron-job sotto il menu Strumenti