/apple-music-plus-backend

Stay updated on new music from your favorite artists!

Primary LanguagePHP

AM+

Stay updated on new music from your favorite artists!

iOS Shortcuts

Subscribe to an artist

https://www.icloud.com/shortcuts/1c4f2d2e1b1245deb0433dfbce78853e

Add the shortcut by filling your API token and base URL (starting with `https://ˋ), go on an artist page in the Music app, click "Share" and "Follow artist" (or whatever the name of the shortcut).

See also

Installation

Deploy

.env

todo

Permissions

cd /path/to/root
sudo chown -R www-data:www-data .
sudo usermod -a -G www-data <USER>
sudo find . -type f -exec chmod 644 {} \;
sudo find . -type d -exec chmod 755 {} \;
sudo chgrp -R www-data storage bootstrap/cache
sudo chmod -R ug+rwx storage bootstrap/cache

Run locally

Open 2 terminals, one for serve, one for artisan queue command :

php artisan serve  --port=8080
php artisan queue:work --queue=update-artist --daemon

Apache conf example

Define APP_DIR c:/.../apple-music-plus-backend
Define APP_URL server-name.wip

<VirtualHost ${APP_URL}:80>
    DocumentRoot ${APP_DIR}/public
    ServerName ${APP_URL}
	ErrorLog ${INSTALL_DIR}/logs/amplus-error.log
	CustomLog ${INSTALL_DIR}/logs/amplus-access.log combined
    <Directory "${APP_DIR}/public">
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
</VirtualHost>

# OR

Define APP_DIR c:/.../apple-music-plus-backend
Define APP_URL server-name.wip

<VirtualHost *:80>
    ServerName ${APP_URL}
    DocumentRoot ${APP_DIR}/public
    ErrorLog ${APACHE_LOG_DIR}/amplus-error.log
    CustomLog ${APACHE_LOG_DIR}/amplus-access.log combined

    <Directory ${APP_DIR}/public>
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>

    <FilesMatch "\.php$">
#        SetHandler "proxy:unix:/var/run/php/php-fpm.sock|fcgi://localhost/"
    </FilesMatch>

    <Files "robots.txt">
        Require all granted
    </Files>

    <Files "favicon.ico">
        Require all granted
    </Files>

    <IfModule mod_headers.c>
        Header always set X-Frame-Options "SAMEORIGIN"
        Header always set X-Content-Type-Options "nosniff"
    </IfModule>

    ErrorDocument 404 /index.php

    <DirectoryMatch "^/.well-known">
        Require all granted
    </DirectoryMatch>

    <FilesMatch "^\.">
        Require all denied
    </FilesMatch>
</VirtualHost>

Run the Scheduler

crontab -e
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

https://laravel.com/docs/10.x/scheduling#running-the-scheduler

Run queues

Install supervisor

sudo apt install supervisor

Default queue

Create file /etc/supervisor/conf.d/amplus-default.conf and write :

[program:default-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/laravel-example/artisan queue:work --sleep=3 --tries=3
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=<YOUR-USER>
numprocs=8
redirect_stderr=true
stdout_logfile=/var/www/laravel-example/storage/logs/default-worker.log
stopwaitsecs=3600

Update artist

Create file /etc/supervisor/conf.d/amplus-update-artist.conf and write :

[program:update-artist-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/laravel-example/artisan queue:work --queue=update-artist --sleep=3 --tries=3
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=<YOUR-USER>
numprocs=8
redirect_stderr=true
stdout_logfile=/var/www/laravel-example/storage/logs/update-artist-worker.log
stopwaitsecs=3600

Start queues workers

Start supervisor

sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start "default-worker:*"
sudo supervisorctl start "update-artist-worker:*"

Commands

Update all artists

php artisan app:fetch-all-artists {job=0}

Update artist

php artisan app:fetch-artist {Artist.storeId} {job=0}

Routes

/api/auth

  • POST /api/auth/register
    • name* (string)
    • email* (string)
    • password* (string)
  • POST /api/auth/login
    • email* (string)
    • password* (string)

...

  • GET /api/developer_token

/api/artist

  • POST /api/artist : update artist
    • artist_id* (int : storeId)
  • GET /api/artist/list : list all artists (pagination & limit)
    • sort (string : name | -name | store_id | -store_id | label | -label | last_updated | -last_updated | last_created | -last_created)
    • page (integer : >= 1)
    • limit (integer : 5 >= 1000)
  • POST /api/artist/fetch : fetch artist's releases
    • artist_id* (int : storeId)
    • job (boolean, default : false)
  • POST /api/artist/fetchall : fetch all artists releases
    • job (boolean, default : false)

/api/user (sanctum middleware)

Use token as Bearer token.

  • GET /api/user
  • GET /api/user/artists
    • sort (string : name | -name | store_id | -store_id | label | -label | last_updated | -last_updated | last_created | -last_created)
    • page (integer : >= 1)
    • limit (integer : 5 >= 1000)
  • GET /api/user/artists/search
    • term* (string : <= 255)
    • page (integer : >= 1)
    • l (string)
    • limit (integer : 5 <= 25)
    • offset (string)
    • with (string)
  • POST /api/user/artists/fetchall
    • job (boolean, default : false)
  • POST /api/user/artists/subscribe
    • artist_id* (int : storeId)
    • fetch (boolean, default : false)
  • POST /api/user/artists/unsubscribe
    • artist_id* (int : storeId)

/api/user/releases

  • GET /api/user/releases

    • sort (string : name | -name | artistName | -artistName | releaseDate | -releaseDate - created_at | -created_at)
    • from (string : date format YYYY-MM-DD),
    • hide_albums (boolean)
    • hide_eps (boolean)
    • hide_singles (boolean)
    • content_rating (string)
    • all_content_rating (boolean)
    • weekly (boolean)
    • artists_ids (string[] : artists.storeId, must exist)'
    • hide_upcoming (boolean : prohibits only_upcoming)
    • only_upcoming (boolean : prohibits hide_upcoming)

    Related & useful routes

    -   GET /api/user/releases/albums
-   GET /api/user/releases/singles
-   GET /api/user/releases/eps
-   GET /api/user/releases/projects

  • GET /api/user/releases/songs

    • sort (string : name | -name | artistName | -artistName | releaseDate | -releaseDate | - created_at | -created_at)
    • from (string : date format YYYY-MM-DD),
    • content_rating (string)
    • all_content_rating (boolean)
    • weekly (boolean)
    • 'weeks' => 'integer|min:1',
    • include_releases (boolean)
    • artists_ids (string[] : artists.storeId, must exist)'
    • hide_upcoming (boolean : prohibits only_upcoming)
    • only_upcoming (boolean : prohibits hide_upcoming)

/api/user/tokens

  • GET /api/user/tokens
  • POST /api/user/tokens/create
    • token_name (string)
  • DELETE /api/user/tokens/delete
    • token_name (string) OR id (int)

/api/applemusic

/api/applemusic/library (musicKit middleware)

  • POST /api/applemusic/library
    • type* (string : albums | songs)
    • ids (string[] : storeId)

Tips

Scheduler

List all scheduled jobs

php artisan schedule:list

Queues & jobs

Execute queue jobs.

php artisan queue:work --stop-when-empty

Execute queue jobs in the background.

php artisan queue:work --daemon # --queue=update-artist

Clear jobs.

php artisan queue:clear # --queue=update-artist

Common issues

SQLite

If you are using SQLite, you'd maybe need to install php-sqlite3 or enable sqlite in your php.ini.

apt-get install php-sqlite3