Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
576 lines (507 loc) · 28.6 KB
/
Copy pathMakefile
File metadata and controls
576 lines (507 loc) · 28.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
# =============================================================================
# Episciences GPL - Development Makefile
# =============================================================================
# Suppress directory change messages
MAKEFLAGS += --no-print-directory
# Include sub-makefiles
include makefiles/deploy.mk
include makefiles/database.mk
include makefiles/testing.mk
# Configuration Variables
DOCKER := docker
DOCKER_COMPOSE := docker compose
NPX := npx
PROJECT_NAME := episciences
# Container Configuration
CNTR_NAME_SOLR := episciences-solr
CNTR_NAME_PHP := php-fpm
CNTR_NAME_HTTPD := httpd
CNTR_APP_DIR := /var/www/htdocs
CNTR_APP_USER := www-data
# Override with 0:0 if composer-install fails (rootless Docker or uid mismatch):
# make dev-setup CNTR_USER_ID=0:0
CNTR_USER_ID := 1000:1000
# Paths Configuration
SOLR_COLLECTION_CONFIG := /opt/configsets/episciences
# =============================================================================
# PHONY Targets
# =============================================================================
.PHONY: help build up down status logs restart clean clean-mysql
.PHONY: collection collection-ref-pps index import-ref-pps download-ref-pps dev-setup setup-logs copy-config generate-users init-dev-users create-bot-user init-data-dir yarn-encore-dev
.PHONY: send-mails composer-install composer-update yarn-encore-production
.PHONY: restart-httpd restart-php merge-pdf-volume
.PHONY: get-classification-msc get-classification-jel can-i-use-update
.PHONY: enter-container-php
.PHONY: update-geoip stats-process stats-update-robots-list stats-download-kpi
.PHONY: format format-check format-tests format-file
# =============================================================================
# Help & Information
# =============================================================================
help: ## Display this help message
@echo "Episciences GPL - Development Environment"
@echo "========================================"
@echo ""
@echo "🐳 Core Docker Commands:"
@grep -E '^(build|up|down|status|logs|restart|clean|clean-mysql):.*##' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}'
@echo ""
@echo "🗄️ Database Commands:"
@grep -h -E '^(wait-for-db|load-db.*|generate-users|shell-mysql.*|backup-db):.*##' $(MAKEFILE_LIST) 2>/dev/null | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}' || echo " No database commands found"
@echo ""
@echo "🔍 Solr Commands:"
@grep -E '^(collection|collection-ref-pps|index|import-ref-pps|download-ref-pps):.*##' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}'
@echo ""
@echo "🛠️ Development Commands:"
@grep -E '^(dev-setup|composer|yarn|enter):.*##' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}'
@echo ""
@echo "🧪 Testing Commands:"
@grep -h -E '^test.*:.*##' $(MAKEFILE_LIST) 2>/dev/null | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}' || echo " No testing commands found"
@echo ""
@echo "🔎 Linting & Quality Commands:"
@grep -h -E '^(phpstan|rector).*:.*##' $(MAKEFILE_LIST) 2>/dev/null | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}' || echo " No quality commands found"
@echo ""
@echo "✨ Formatting Commands:"
@grep -E '^format.*:.*##' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}'
@echo ""
@echo "🚀 Deployment Commands:"
@grep -h -E '^deploy.*:.*##' $(MAKEFILE_LIST) 2>/dev/null | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}' || echo " No deployment commands found"
@echo ""
@echo "📦 Other Commands:"
@grep -E '^(send-mails|merge-pdf|get-classification|can-i-use|import-apache-logs):.*##' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf " %-25s %s\n", $$1, $$2}'
# =============================================================================
# Core Docker Commands
# =============================================================================
build: ## Build all docker containers
@echo "Building Docker containers..."
$(DOCKER_COMPOSE) build
up: ## Start all docker containers
@echo "Starting Docker containers..."
$(DOCKER_COMPOSE) up -d
@echo "====================================================================="
@echo "Development Environment Started Successfully!"
@echo "====================================================================="
@echo "📝 Make sure you have the following in /etc/hosts:"
@echo "127.0.0.1 localhost dev.episciences.org oai-dev.episciences.org data-dev.episciences.org manager-dev.episciences.org mailpit.episciences.org"
@echo ""
@echo "🌐 Available Services (via Traefik — start episciences-infrastructure first):"
@echo " Journal : https://dev.episciences.org/"
@echo " Manager : https://manager-dev.episciences.org/dev/"
@echo " OAI-PMH : https://oai-dev.episciences.org/"
@echo " Data : https://data-dev.episciences.org/"
@echo " PhpMyAdmin : https://pma.episciences.org/"
@echo " Apache Solr : http://localhost:8983/solr"
@echo " Mailpit : https://mailpit.episciences.org/"
@echo "====================================================================="
down: ## Stop all docker containers and remove orphans
@echo "Stopping Docker containers..."
$(DOCKER_COMPOSE) down --remove-orphans
status: ## Show status of all containers
@echo "Container Status:"
@echo "=================="
@$(DOCKER) ps -a --filter "name=$(PROJECT_NAME)" --format "table {{.Names}}\t{{.Status}}\t{{.Ports}}"
logs: ## Show logs from all containers (use CONTAINER=name for specific container)
ifdef CONTAINER
@echo "Showing logs for container: $(CONTAINER)"
@$(DOCKER) logs -f $(CONTAINER)
else
@echo "Showing logs for all containers (press Ctrl+C to stop):"
@$(DOCKER_COMPOSE) logs -f
endif
restart: down up ## Restart all containers
# =============================================================================
# Cleanup Commands
# =============================================================================
clean: down ## Clean up unused docker resources
@echo "Cleaning up Docker resources..."
@$(DOCKER) system prune -f
clean-mysql: down ## Remove all MySQL volumes (WARNING: This will delete all database data!)
@echo "WARNING: This will permanently delete all MySQL database data!"
@echo "This may be needed when downgrading from MySQL 8.4 to 8.0"
@echo ""
@echo "Volumes to be removed:"
@echo " - $(VOLUME_MYSQL_EPISCIENCES)"
@echo " - $(VOLUME_MYSQL_INDEXING)"
@echo " - $(VOLUME_MYSQL_AUTH)"
@echo ""
@printf "Type 'Yes delete database volumes' to confirm: "; \
read -r answer; \
if [ "$$answer" = "Yes delete database volumes" ]; then \
echo "Removing MySQL volumes..."; \
$(DOCKER) volume rm $(VOLUME_MYSQL_EPISCIENCES) $(VOLUME_MYSQL_INDEXING) $(VOLUME_MYSQL_AUTH) 2>/dev/null || true; \
echo "MySQL volumes removed successfully."; \
else \
echo "Operation cancelled."; \
fi
# =============================================================================
# Solr Commands
# =============================================================================
collection: ## Create Solr collection 'episciences' (requires episciences-infrastructure running)
@echo "Setting up Solr collection 'episciences'..."
@echo "Waiting for Solr to be ready..."
@until $(DOCKER) exec $(CNTR_NAME_SOLR) curl -s http://localhost:8983/solr >/dev/null 2>&1; do \
echo "Waiting for Solr..."; \
sleep 2; \
done
@echo "Solr is ready. Creating 'episciences' collection..."
@$(DOCKER) exec $(CNTR_NAME_SOLR) /opt/solr/bin/solr zk upconfig \
-d $(SOLR_COLLECTION_CONFIG) -n episciences -z episciences-zoo:2181
@$(DOCKER) exec $(CNTR_NAME_SOLR) \
curl -sf "http://localhost:8983/solr/admin/collections?action=CREATE&name=episciences&numShards=1&replicationFactor=1&collection.configName=episciences" \
>/dev/null 2>&1 || echo "Collection may already exist, continuing..."
@echo "Solr collection setup complete!"
collection-ref-pps: ## Create Solr core 'ref_pps' (requires episciences-infrastructure running)
@echo "Setting up Solr core 'ref_pps'..."
@echo "Waiting for Solr to be ready..."
@until $(DOCKER) exec $(CNTR_NAME_SOLR) curl -s http://localhost:8983/solr >/dev/null 2>&1; do \
echo "Waiting for Solr..."; \
sleep 2; \
done
@echo "Solr is ready. Creating 'ref_pps' core..."
@$(DOCKER) exec -u 0:0 $(CNTR_NAME_SOLR) mkdir -p /opt/solr/server/solr/configsets/ref_pps
@docker cp src/solr/ref_pps/conf $(CNTR_NAME_SOLR):/opt/solr/server/solr/configsets/ref_pps/
@$(DOCKER) exec $(CNTR_NAME_SOLR) solr create_core -c ref_pps \
-d /opt/solr/server/solr/configsets/ref_pps/conf -s http://localhost:8983 || \
echo "Core may already exist, continuing..."
@echo "Solr core ref_pps setup complete!"
index: ## Index content into Solr [V=1 verbose] [D=1 debug]
@echo "Indexing content into Solr..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) php scripts/solr/solrJob.php -D % $(if $(V),-v) $(if $(D),-d)
@echo "Indexing complete!"
import-ref-pps: ## Import PPS data from CSV into Solr core ref_pps (optional: csv-file=PATH)
@echo "Importing PPS data into Solr..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php import:ref-pps $(if $(csv-file),$(csv-file))
@echo "Import complete!"
download-ref-pps: ## Download PPS CSV file from IRIT (optional: force=1)
@echo "Downloading PPS data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php download:ref-pps $(if $(filter 1,$(force)),--force)
@echo "Download complete!"
# =============================================================================
# Development Setup Commands
# =============================================================================
dev-setup: build copy-config setup-logs up wait-for-db init-data-dir ## Complete development environment setup (requires episciences-infrastructure running)
@echo "Setting up complete development environment..."
@echo "⚠️ Make sure episciences-infrastructure is running (cd ../episciences-infrastructure && make up)"
@$(MAKE) composer-install
@$(MAKE) yarn-encore-dev
@$(MAKE) load-dev-db
@$(MAKE) init-dev-users
@$(MAKE) create-bot-user
@$(MAKE) collection
@$(MAKE) index
@echo "Development environment setup complete!"
@echo ""
@echo "====================================================================="
@echo "🔑 TEST USER CREDENTIALS"
@echo "====================================================================="
@echo "30 users have been created for the 'dev' journal (RVID 1)."
@echo "Default password for all: password123"
@echo "Available roles: 1 Chief Editor, 2 Administrators, 5 Editors, 22 Members"
@echo "====================================================================="
setup-logs: ## Setup log directory and files with correct permissions
@echo "Setting up logs..."
@./scripts/setup-logs.sh
copy-config: ## Copy dist-dev.pwd.json to config/pwd.json if it doesn't exist
@if [ -f config/pwd.json ]; then \
echo "config/pwd.json already exists."; \
printf "Overwrite with dist-dev.pwd.json? (y/N): "; \
read -r answer; \
if [ "$$answer" = "y" ] || [ "$$answer" = "Y" ]; then \
cp config/dist-dev.pwd.json config/pwd.json; \
echo "config/pwd.json overwritten."; \
else \
echo "Keeping existing config/pwd.json."; \
fi; \
else \
cp config/dist-dev.pwd.json config/pwd.json; \
echo "config/pwd.json created from dist-dev.pwd.json."; \
fi
init-data-dir: ## Create data/dev directory with correct permissions for the journal
@echo "Initializing data/dev directory..."
@$(DOCKER_COMPOSE) exec -u 0:0 -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
sh -c "chown $(CNTR_APP_USER):$(CNTR_APP_USER) data && chmod 775 data \
&& cp -rn src/data/default data/ 2>/dev/null || true \
&& mkdir -p data/dev/config data/dev/files data/dev/languages data/dev/layout data/dev/public data/dev/tmp \
&& cp -n data/default/config/navigation.json data/dev/config/navigation.json 2>/dev/null || true \
&& chown -R $(CNTR_APP_USER):$(CNTR_APP_USER) data/dev \
&& chmod -R 775 data/dev \
&& find /tmp -maxdepth 1 -name 'zend_cache---*' ! -user $(CNTR_APP_USER) -delete 2>/dev/null || true"
@echo "data/dev directory ready."
generate-users: ## Generate random test users (usage: make generate-users COUNT=10 ROLE=editor)
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) php scripts/console.php app:generate-users --count=$(or $(COUNT),5) --role=$(or $(ROLE),member) --rvcode=dev
init-dev-users: ## Initialize journal 'dev' with 30 users (1 chief, 2 admins, 5 editors, 22 members)
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) php scripts/console.php app:init-dev-users
create-bot-user: ## Create the fixed episciences-bot user
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) php scripts/console.php app:create-bot-user
# =============================================================================
# PHP Development Commands
# =============================================================================
composer-install: ## Install composer dependencies
@echo "Installing Composer dependencies..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_USER_ID) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) composer install --no-interaction --prefer-dist --optimize-autoloader
composer-update: ## Update composer dependencies
@echo "Updating Composer dependencies..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_USER_ID) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) composer update --no-interaction --prefer-dist --optimize-autoloader
yarn-encore-dev: ## Build frontend assets for development
@echo "Building frontend assets (dev)..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_USER_ID) -e HOME=/tmp -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) yarn install
@$(DOCKER_COMPOSE) exec -u $(CNTR_USER_ID) -e HOME=/tmp -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) yarn encore dev
yarn-encore-production: ## Build frontend assets for production
@echo "Building frontend assets..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_USER_ID) -e HOME=/tmp -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) yarn install
@$(DOCKER_COMPOSE) exec -u $(CNTR_USER_ID) -e HOME=/tmp -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) yarn encore production
enter-container-php: ## Open shell in PHP container
@$(DOCKER_COMPOSE) exec $(CNTR_NAME_PHP) sh -c "cd $(CNTR_APP_DIR) && /bin/bash"
# =============================================================================
# Service Management Commands
# =============================================================================
restart-httpd: ## Restart Apache httpd container
@echo "Restarting Apache httpd..."
@$(DOCKER_COMPOSE) restart $(CNTR_NAME_HTTPD)
restart-php: ## Restart PHP-FPM container
@echo "Restarting PHP-FPM..."
@$(DOCKER_COMPOSE) restart $(CNTR_NAME_PHP)
# =============================================================================
# Application Specific Commands
#
# These targets are development shortcuts that run Episciences CLI commands
# inside the PHP container as $(CNTR_APP_USER).
#
# In production, commands are run directly on the server (no Make, no Docker):
# sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php <command> [options]
#
# All console commands accept --dry-run (simulate without writing) and -q (quiet/cron mode).
# Run `php scripts/console.php list` for the full list of available commands.
# =============================================================================
# --- Mail -----------------------------------------------------------------------
send-mails: ## Flush the mail queue now (without waiting for the cron)
@echo "Sending queued emails..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/send_mails.php
# --- Enrichment -----------------------------------------------------------------
enrich-citations: ## Enrich citation data from the Episciences API
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:citations [-q] [--dry-run]
@echo "Enriching citation data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:citations
enrich-creators: ## Enrich author ORCID data from OpenAIRE Research Graph and HAL TEI
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:creators [-q] [--dry-run]
@echo "Enriching author (creator) data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:creators
enrich-licences: ## Enrich licence data from the Episciences API
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:licences [-q] [--dry-run]
@echo "Enriching licence data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:licences
enrich-links: ## Enrich link data from the Episciences API
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:links [-q] [--dry-run]
@echo "Enriching link data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:links
enrich-funding: ## Enrich funding data from OpenAIRE Research Graph
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:funding [-q] [--dry-run]
@echo "Enriching funding data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:funding
get-classification-jel: ## Enrich JEL classification data from OpenAIRE Research Graph
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:classifications-jel [-q] [--dry-run]
@echo "Enriching JEL classification data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:classifications-jel
get-classification-msc: ## Enrich MSC 2020 classification data from zbMATH Open
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:classifications-msc [-q] [--dry-run]
@echo "Enriching MSC 2020 classification data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:classifications-msc
enrich-zb-reviews: ## Enrich zbMATH review data
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php enrichment:zb-reviews [-q] [--dry-run]
@echo "Enriching zbMATH review data..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php enrichment:zb-reviews
# --- Sitemap --------------------------------------------------------------------
generate-sitemap: ## Generate XML sitemap — use rvcode=CODE for one journal, or all=1 for all active journals (optional: pretty=1)
# Prod (one journal): sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php sitemap:generate --rvcode=RVCODE [--pretty] [-q]
# Prod (all journals): sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php sitemap:generate --all [--pretty] [-q]
@if [ -z "$(rvcode)" ] && [ "$(all)" != "1" ]; then \
echo "Error: specify rvcode=JOURNAL_CODE or all=1"; \
echo "Usage: make generate-sitemap rvcode=JOURNAL_CODE [pretty=1]"; \
echo " make generate-sitemap all=1 [pretty=1]"; \
exit 1; \
fi
@if [ -n "$(rvcode)" ]; then \
echo "Generating sitemap for journal '$(rvcode)'..."; \
$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php sitemap:generate --rvcode=$(rvcode) \
$(if $(filter 1,$(pretty)),--pretty); \
else \
echo "Generating sitemaps for all active journals..."; \
$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php sitemap:generate --all \
$(if $(filter 1,$(pretty)),--pretty); \
fi
# --- Volume / DOAJ --------------------------------------------------------------
merge-pdf-volume: ## Merge PDFs for all articles in a journal volume into one file (requires rvcode=JOURNAL_CODE; optional: ignore-cache=1 remove-cache=1 dry-run=1)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php volume:merge-pdf --rvcode=RVCODE [--ignore-cache] [--remove-cache] [--dry-run] [-q]
@if [ -z "$(rvcode)" ]; then \
echo "Error: rvcode parameter is required"; \
echo "Usage: make merge-pdf-volume rvcode=JOURNAL_CODE [ignore-cache=1] [remove-cache=1] [dry-run=1]"; \
exit 1; \
fi
@echo "Merging PDFs for journal '$(rvcode)'..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php volume:merge-pdf \
--rvcode=$(rvcode) \
$(if $(filter 1,$(ignore-cache)),--ignore-cache) \
$(if $(filter 1,$(remove-cache)),--remove-cache) \
$(if $(filter 1,$(dry-run)),--dry-run)
doaj-export-volumes: ## Create DOAJ XML volume exports (requires rvcode=JOURNAL_CODE or rvcode=allJournals; optional: ignore-cache=1 remove-cache=1 dry-run=1)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php doaj:export-volumes --rvcode=RVCODE|allJournals [--ignore-cache] [--remove-cache] [--dry-run] [-q]
@if [ -z "$(rvcode)" ]; then \
echo "Error: rvcode parameter is required"; \
echo "Usage: make doaj-export-volumes rvcode=JOURNAL_CODE|allJournals [ignore-cache=1] [remove-cache=1] [dry-run=1]"; \
exit 1; \
fi
@echo "Creating DOAJ volume exports for '$(rvcode)'..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php doaj:export-volumes \
--rvcode=$(rvcode) \
$(if $(filter 1,$(ignore-cache)),--ignore-cache) \
$(if $(filter 1,$(remove-cache)),--remove-cache) \
$(if $(filter 1,$(dry-run)),--dry-run)
# --- Import ---------------------------------------------------------------------
import-sections: ## Import journal sections from a CSV file (requires csv-file=PATH; optional: dry-run=1)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php import:sections --csv-file=PATH [--dry-run] [-q]
@if [ -z "$(csv-file)" ]; then \
echo "Error: csv-file parameter is required"; \
echo "Usage: make import-sections csv-file=PATH/TO/FILE.csv [dry-run=1]"; \
exit 1; \
fi
@echo "Importing sections from '$(csv-file)'..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php import:sections \
--csv-file=$(csv-file) \
$(if $(filter 1,$(dry-run)),--dry-run)
import-volumes: ## Import journal volumes from a CSV file (requires rvid=JOURNAL_RVID csv-file=PATH; optional: dry-run=1)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php import:volumes --rvid=RVID --csv-file=PATH [--dry-run] [-q]
@if [ -z "$(rvid)" ] || [ -z "$(csv-file)" ]; then \
echo "Error: rvid and csv-file parameters are required"; \
echo "Usage: make import-volumes rvid=JOURNAL_RVID csv-file=PATH/TO/FILE.csv [dry-run=1]"; \
exit 1; \
fi
@echo "Importing volumes for RVID $(rvid) from '$(csv-file)'..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php import:volumes \
--rvid=$(rvid) \
--csv-file=$(csv-file) \
$(if $(filter 1,$(dry-run)),--dry-run)
# --- zbJATS ---------------------------------------------------------------------
zbjats-zip: ## Download PDF + zbJATS XML per volume and create a ZIP archive (requires rvid=JOURNAL_RVID; optional: zip-prefix=PREFIX dry-run=1)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php zbjats:zip --rvid=RVID [--zip-prefix=PREFIX] [--dry-run] [-q]
@if [ -z "$(rvid)" ]; then \
echo "Error: rvid parameter is required"; \
echo "Usage: make zbjats-zip rvid=JOURNAL_RVID [zip-prefix=PREFIX] [dry-run=1]"; \
exit 1; \
fi
@echo "Creating zbJATS ZIP for RVID $(rvid)..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php zbjats:zip \
--rvid=$(rvid) \
$(if $(zip-prefix),--zip-prefix=$(zip-prefix)) \
$(if $(filter 1,$(dry-run)),--dry-run)
# --- Stats / GeoIP -------------------------------------------------------------
update-geoip: ## Download or update GeoLite2-City.mmdb (credentials from config/pwd.json GEO_IP section; optional: force=1 dry-run=1)
# Set GEO_IP.ACCOUNT_ID and GEO_IP.LICENSE_KEY in config/pwd.json
# Get a free account at: https://www.maxmind.com/en/geolite2/signup
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php geoip:update \
$(if $(filter 1,$(force)),--force) \
$(if $(filter 1,$(dry-run)),--dry-run)
stats-update-robots-list: ## Download the COUNTER Robots list for bot detection (optional: dry-run=1 force=1)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php stats:update-robots-list [-q]
@echo "Downloading COUNTER Robots list..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php stats:update-robots-list \
$(if $(filter 1,$(force)),--force) \
$(if $(filter 1,$(dry-run)),--dry-run)
stats-process: ## Process STAT_TEMP into PAPER_STAT (optional: date=YYYY-MM-DD all=1 dry-run=1)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php stats:process [-q]
@echo "Processing statistics..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php stats:process \
$(if $(date),--date-s=$(date)) \
$(if $(filter 1,$(all)),--all) \
$(if $(filter 1,$(dry-run)),--dry-run)
stats-download-kpi: ## Generate download KPI JSON for all published articles (optional: rvcode=xxx pretty=1 dry-run=1 output=path)
# Prod: sudo -u $(CNTR_APP_USER) php $(CNTR_APP_DIR)/scripts/console.php stats:download-kpi [-q]
@echo "Generating download KPI JSON..."
@$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) \
php scripts/console.php stats:download-kpi \
$(if $(rvcode),--rvcode=$(rvcode)) \
$(if $(filter 1,$(pretty)),--pretty) \
$(if $(filter 1,$(dry-run)),--dry-run) \
$(if $(output),--output=$(output))
can-i-use-update: ## Update browserslist database when caniuse-lite is outdated
@echo "Updating browserslist database..."
@$(NPX) update-browserslist-db@latest
import-apache-logs: ## Parse Apache logs into STAT_TEMP (rvcode=JOURNAL|all=1 [date=YYYY-MM-DD|month=YYYY-MM|year=YYYY|start-date=…+end-date=…] [logs-path=PATH] [force=1])
@if [ -z "$(rvcode)" ] && [ "$(all)" != "1" ]; then \
echo "Error: specify rvcode=JOURNAL_CODE or all=1"; \
echo "Usage: make import-apache-logs rvcode=JOURNAL_CODE [options]"; \
echo " make import-apache-logs all=1 [options]"; \
echo "Options:"; \
echo " date=YYYY-MM-DD Process a specific day"; \
echo " month=YYYY-MM Process entire month"; \
echo " year=YYYY Process entire year"; \
echo " start-date=YYYY-MM-DD Start date for custom range"; \
echo " end-date=YYYY-MM-DD End date for custom range"; \
echo " logs-path=PATH Base path to Apache log directory"; \
echo " force=1 Force reprocessing of already-processed dates"; \
exit 1; \
fi
@cmd="php scripts/console.php stats:import-logs"; \
if [ "$(all)" = "1" ]; then \
cmd="$$cmd --all"; \
else \
cmd="$$cmd --rvcode=$(rvcode)"; \
fi; \
if [ -n "$(date)" ]; then \
cmd="$$cmd --date=$(date)"; \
elif [ -n "$(month)" ]; then \
cmd="$$cmd --month=$(month)"; \
elif [ -n "$(year)" ]; then \
cmd="$$cmd --year=$(year)"; \
elif [ -n "$(start-date)" ] && [ -n "$(end-date)" ]; then \
cmd="$$cmd --start-date=$(start-date) --end-date=$(end-date)"; \
fi; \
if [ -n "$(logs-path)" ]; then \
cmd="$$cmd --logs-path=$(logs-path)"; \
fi; \
if [ "$(force)" = "1" ]; then \
cmd="$$cmd --force"; \
fi; \
$(DOCKER_COMPOSE) exec -u $(CNTR_APP_USER) -w $(CNTR_APP_DIR) $(CNTR_NAME_PHP) $$cmd
# =============================================================================
# Code Formatting Commands (Prettier)
# =============================================================================
format: ## Format all JavaScript files with Prettier
@echo "Formatting JavaScript files..."
@yarn format
format-check: ## Check JavaScript formatting without modifying files
@echo "Checking JavaScript formatting..."
@yarn format:check
format-tests: ## Format JavaScript test files
@echo "Formatting JavaScript test files..."
@yarn format:tests
format-file: ## Format a specific file with Prettier (usage: make format-file FILE=path/to/file.js)
@if [ -z "$(FILE)" ]; then \
echo "Error: FILE parameter is required"; \
echo "Usage: make format-file FILE=path/to/file.js"; \
exit 1; \
fi
@echo "Formatting $(FILE)..."
@yarn prettier --write "$(FILE)"
# =============================================================================
# Default Target
# =============================================================================
.DEFAULT_GOAL := help