diff --git a/.editorconfig b/.editorconfig index 0b5d680f..546affff 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,21 +1,21 @@ +# EditorConfig is awesome: http://EditorConfig.org + +# top-most EditorConfig file root = true +# Unix-style newlines with a newline ending every file [*] -charset = utf-8 end_of_line = lf -indent_size = 4 -indent_style = space +charset = utf-8 insert_final_newline = true trim_trailing_whitespace = true - -[*.{js,css}] -indent_size = 2 - -[*.md] -trim_trailing_whitespace = false - -[*.{yml,yaml}] -indent_size = 2 - -[docker-compose.yml] +indent_style = space indent_size = 4 + +# Tab indentation +[Makefile] +indent_style = tab +tab_width = 4 + +[yml] +indent_size = 2 diff --git a/.env.dusk.testing b/.env.dusk.testing new file mode 100644 index 00000000..756f4074 --- /dev/null +++ b/.env.dusk.testing @@ -0,0 +1,14 @@ +APP_ENV=testing +APP_DEBUG=true +APP_KEY=base64:6DJhvZLVjE6dD4Cqrteh+6Z5vZlG+v/soCKcDHLOAH0= +APP_URL=http://localhost:8000 +APP_LONGURL=localhost +APP_SHORTURL=local + +DB_CONNECTION=travis + +CACHE_DRIVER=array +SESSION_DRIVER=file +QUEUE_DRIVER=sync + +SCOUT_DRIVER=pgsql diff --git a/.env.example b/.env.example index 4eb61db5..d1a26e82 100644 --- a/.env.example +++ b/.env.example @@ -1,90 +1,70 @@ APP_NAME=Laravel -APP_ENV=local -APP_KEY= -APP_DEBUG=true -APP_TIMEZONE=UTC -APP_URL=https://example.com +APP_ENV=production +APP_KEY=SomeRandomString # Leave this +APP_DEBUG=false +APP_LOG_LEVEL=warning -APP_LOCALE=en -APP_FALLBACK_LOCALE=en -APP_FAKER_LOCALE=en_US - -APP_MAINTENANCE_DRIVER=file -# APP_MAINTENANCE_STORE=database - -PHP_CLI_SERVER_WORKERS=4 - -BCRYPT_ROUNDS=12 - -LOG_CHANNEL=stack -LOG_STACK=single -LOG_DEPRECATIONS_CHANNEL=null -LOG_LEVEL=debug - -DB_CONNECTION=mysql +DB_CONNECTION=pgsql DB_HOST=127.0.0.1 -DB_PORT=3306 -DB_DATABASE=laravel -DB_USERNAME=root +DB_PORT=5432 +DB_DATABASE= +DB_USERNAME= DB_PASSWORD= -SESSION_DRIVER=database -SESSION_LIFETIME=120 -SESSION_ENCRYPT=false -SESSION_PATH=/ -SESSION_DOMAIN=null +BROADCAST_DRIVER=log +CACHE_DRIVER=file +SESSION_DRIVER=file +QUEUE_DRIVER=sync -BROADCAST_CONNECTION=log -FILESYSTEM_DISK=local -QUEUE_CONNECTION=database - -CACHE_STORE=database -# CACHE_PREFIX= - -MEMCACHED_HOST=127.0.0.1 - -REDIS_CLIENT=phpredis REDIS_HOST=127.0.0.1 REDIS_PASSWORD=null REDIS_PORT=6379 -MAIL_MAILER=log -MAIL_SCHEME=null -MAIL_HOST=127.0.0.1 +MAIL_DRIVER=smtp +MAIL_HOST=smtp.mailtrap.io MAIL_PORT=2525 MAIL_USERNAME=null MAIL_PASSWORD=null MAIL_ENCRYPTION=null -MAIL_FROM_ADDRESS="hello@example.com" -MAIL_FROM_NAME="${APP_NAME}" -AWS_ACCESS_KEY_ID= -AWS_SECRET_ACCESS_KEY= -AWS_DEFAULT_REGION=us-east-1 -AWS_BUCKET= -AWS_USE_PATH_STYLE_ENDPOINT=false +PUSHER_APP_ID= +PUSHER_APP_KEY= +PUSHER_APP_SECRET= -VITE_APP_NAME="${APP_NAME}" +AWS_S3_KEY=your-key +AWS_S3_SECRET=your-secret +AWS_S3_REGION=region +AWS_S3_BUCKET=your-bucket +AWS_S3_URL=https://xxxxxxx.s3-region.amazonaws.com -ADMIN_USER=admin# pick something better, this is used for `/admin` +APP_URL=https://example.com # This one is necessary +APP_LONGURL=example.com +APP_SHORTURL=examp.le + +ADMIN_USER=admin # pick something better, this is used for `/admin` ADMIN_PASS=password -DISPLAY_NAME='Joe Bloggs'# This is used for example in the header and titles +DISPLAY_NAME='Joe Bloggs' # This is used for example in the header and titles TWITTER_CONSUMER_KEY= TWITTER_CONSUMER_SECRET= TWITTER_ACCESS_TOKEN= TWITTER_ACCESS_TOKEN_SECRET= -SCOUT_DRIVER=database -SCOUT_QUEUE=false +SCOUT_DRIVER=pgsql -SESSION_SECURE_COOKIE=true -SESSION_SAME_SITE=strict +PIWIK=false +PIWIK_ID=1 +PIWIK_URL=https://analytics.jmb.lv/piwik.php + +FATHOM_ID= + +APP_TIMEZONE=UTC +APP_LANG=en +APP_LOG=daily +SECURE_SESSION_COOKIE=true LOG_SLACK_WEBHOOK_URL= -FLARE_KEY= - -IGNITION_OPEN_AI_KEY= +FONT_LINK= BRIDGY_MASTODON_TOKEN= diff --git a/.env.github b/.env.github new file mode 100644 index 00000000..dbc69b67 --- /dev/null +++ b/.env.github @@ -0,0 +1,66 @@ +APP_NAME=Laravel +APP_ENV=testing +APP_KEY=SomeRandomString # Leave this +APP_DEBUG=false +APP_LOG_LEVEL=warning + +DB_CONNECTION=pgsql +DB_HOST=127.0.0.1 +DB_PORT=5432 +DB_DATABASE=jbukdev_testing +DB_USERNAME=postgres +DB_PASSWORD=postgres + +BROADCAST_DRIVER=log +CACHE_DRIVER=file +SESSION_DRIVER=file +QUEUE_DRIVER=sync + +REDIS_HOST=127.0.0.1 +REDIS_PASSWORD=null +REDIS_PORT=6379 + +MAIL_DRIVER=smtp +MAIL_HOST=smtp.mailtrap.io +MAIL_PORT=2525 +MAIL_USERNAME=null +MAIL_PASSWORD=null +MAIL_ENCRYPTION=null + +PUSHER_APP_ID= +PUSHER_APP_KEY= +PUSHER_APP_SECRET= + +AWS_S3_KEY=your-key +AWS_S3_SECRET=your-secret +AWS_S3_REGION=region +AWS_S3_BUCKET=your-bucket +AWS_S3_URL=https://xxxxxxx.s3-region.amazonaws.com + +APP_URL=https://example.com # This one is necessary +APP_LONGURL=example.com +APP_SHORTURL=examp.le + +ADMIN_USER=admin # pick something better, this is used for `/admin` +ADMIN_PASS=password +DISPLAY_NAME="Joe Bloggs" # This is used for example in the header and titles + +TWITTER_CONSUMER_KEY= +TWITTER_CONSUMER_SECRET= +TWITTER_ACCESS_TOKEN= +TWITTER_ACCESS_TOKEN_SECRET= + +SCOUT_DRIVER=pgsql + +PIWIK=false + +FATHOM_ID= + +APP_TIMEZONE=UTC +APP_LANG=en +APP_LOG=daily +SECURE_SESSION_COOKIE=true + +LOG_SLACK_WEBHOOK_URL= + +FONT_LINK= diff --git a/.eslintrc.yml b/.eslintrc.yml new file mode 100644 index 00000000..b6ca2fd4 --- /dev/null +++ b/.eslintrc.yml @@ -0,0 +1,24 @@ +parserOptions: + sourceType: 'module' +extends: 'eslint:recommended' +env: + browser: true + es6: true +rules: + indent: + - error + - 4 + linebreak-style: + - error + - unix + quotes: + - error + - single + semi: + - error + - always + no-console: + - error + - allow: + - warn + - error diff --git a/.gitattributes b/.gitattributes index 78f41d7a..967315dd 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,7 +1,5 @@ -* text=auto eol=lf - -*.blade.php diff=html -*.css diff=css -*.html diff=html -*.md diff=markdown -*.php diff=php +* text=auto +*.css linguist-vendored +*.scss linguist-vendored +*.js linguist-vendored +CHANGELOG.md export-ignore diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..47abe68c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +version: 2 + +updates: + - package-ecosystem: "composer" + directory: "/" + schedule: + interval: "daily" + + - package-ecosystem: "npm" + directory: "/" + schedule: + interval: "daily" diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 00000000..4b65cf07 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,142 @@ +name: Deploy + +on: + workflow_dispatch: + +jobs: + deploy: + name: Deploy + runs-on: ubuntu-latest + environment: Hetzner + env: + repository: 'jonnybarnes/jonnybarnes.uk' + newReleaseName: '${{ github.run_id }}' + + steps: + - name: šŸŒ Set Environment Variables + run: | + echo "releasesDir=${{ secrets.DEPLOYMENT_BASE_DIR }}/releases" >> $GITHUB_ENV + echo "persistentDir=${{ secrets.DEPLOYMENT_BASE_DIR }}/persistent" >> $GITHUB_ENV + echo "currentDir=${{ secrets.DEPLOYMENT_BASE_DIR }}/current" >> $GITHUB_ENV + - name: šŸŒŽ Set Environment Variables Part 2 + run: | + echo "newReleaseDir=${{ env.releasesDir }}/${{ env.newReleaseName }}" >> $GITHUB_ENV + - name: šŸ”„ Clone Repository + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.DEPLOYMENT_HOST }} + port: ${{ secrets.DEPLOYMENT_PORT }} + username: ${{ secrets.DEPLOYMENT_USER }} + key: ${{ secrets.DEPLOYMENT_KEY }} + script: | + [ -d ${{ env.releasesDir }} ] || mkdir ${{ env.releasesDir }} + [ -d ${{ env.persistentDir }} ] || mkdir ${{ env.persistentDir }} + [ -d ${{ env.persistentDir }}/storage ] || mkdir ${{ env.persistentDir }}/storage + + cd ${{ env.releasesDir }} + + # Create new release directory + mkdir ${{ env.newReleaseDir }} + + # Clone app + git clone --depth 1 --branch ${{ github.ref_name }} https://github.com/${{ env.repository }} ${{ env.newReleaseName }} + + # Mark release + cd ${{ env.newReleaseDir }} + echo "${{ env.newReleaseName }}" > public/release-name.txt + + # Fix cache directory permissions + sudo chown -R ${{ secrets.HTTP_USER }}:${{ secrets.HTTP_USER }} bootstrap/cache + + - name: šŸŽµ Run Composer + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.DEPLOYMENT_HOST }} + port: ${{ secrets.DEPLOYMENT_PORT }} + username: ${{ secrets.DEPLOYMENT_USER }} + key: ${{ secrets.DEPLOYMENT_KEY }} + script: | + cd ${{ env.newReleaseDir }} + composer install --prefer-dist --no-scripts --no-dev --no-progress --optimize-autoloader --quiet --no-interaction + + - name: šŸ”— Update Symlinks + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.DEPLOYMENT_HOST }} + port: ${{ secrets.DEPLOYMENT_PORT }} + username: ${{ secrets.DEPLOYMENT_USER }} + key: ${{ secrets.DEPLOYMENT_KEY }} + script: | + # Import the environment config + cd ${{ env.newReleaseDir }}; + ln -nfs ${{ secrets.DEPLOYMENT_BASE_DIR }}/.env .env; + + # Remove the storage directory and replace with persistent data + rm -rf ${{ env.newReleaseDir }}/storage; + cd ${{ env.newReleaseDir }}; + ln -nfs ${{ secrets.DEPLOYMENT_BASE_DIR }}/persistent/storage storage; + + # Remove the public/profile-images directory and replace with persistent data + rm -rf ${{ env.newReleaseDir }}/public/assets/profile-images; + cd ${{ env.newReleaseDir }}; + ln -nfs ${{ secrets.DEPLOYMENT_BASE_DIR }}/persistent/profile-images public/assets/profile-images; + + # Add the persistent files data + cd ${{ env.newReleaseDir }}; + ln -nfs ${{ secrets.DEPLOYMENT_BASE_DIR }}/persistent/files public/files; + + # Add the persistent fonts data + cd ${{ env.newReleaseDir }}; + ln -nfs ${{ secrets.DEPLOYMENT_BASE_DIR }}/persistent/fonts public/fonts; + + - name: āœØ Optimize Installation + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.DEPLOYMENT_HOST }} + port: ${{ secrets.DEPLOYMENT_PORT }} + username: ${{ secrets.DEPLOYMENT_USER }} + key: ${{ secrets.DEPLOYMENT_KEY }} + script: | + cd ${{ env.newReleaseDir }}; + sudo runuser -u ${{ secrets.HTTP_USER }} -- php artisan clear-compiled; + + - name: šŸ™ˆ Migrate database + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.DEPLOYMENT_HOST }} + port: ${{ secrets.DEPLOYMENT_PORT }} + username: ${{ secrets.DEPLOYMENT_USER }} + key: ${{ secrets.DEPLOYMENT_KEY }} + script: | + cd ${{ env.newReleaseDir }} + sudo runuser -u ${{ secrets.HTTP_USER }} -- php artisan migrate --force + + - name: šŸ™ Bless release + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.DEPLOYMENT_HOST }} + port: ${{ secrets.DEPLOYMENT_PORT }} + username: ${{ secrets.DEPLOYMENT_USER }} + key: ${{ secrets.DEPLOYMENT_KEY }} + script: | + ln -nfs ${{ env.newReleaseDir }} ${{ env.currentDir }}; + cd ${{ env.newReleaseDir }} + sudo runuser -u ${{ secrets.HTTP_USER }} -- php artisan horizon:terminate + sudo runuser -u ${{ secrets.HTTP_USER }} -- php artisan config:cache + sudo runuser -u ${{ secrets.HTTP_USER }} -- php artisan event:cache + sudo runuser -u ${{ secrets.HTTP_USER }} -- php artisan route:cache + sudo runuser -u ${{ secrets.HTTP_USER }} -- php artisan view:cache + + sudo systemctl restart php-fpm.service + sudo systemctl restart jbuk-horizon.service + + - name: šŸš¾ Clean up old releases + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.DEPLOYMENT_HOST }} + port: ${{ secrets.DEPLOYMENT_PORT }} + username: ${{ secrets.DEPLOYMENT_USER }} + key: ${{ secrets.DEPLOYMENT_KEY }} + script: | + fd '.+' ${{ env.releasesDir }} -d 1 | head -n -3 | xargs -d "\n" -I'{}' sudo chown -R ${{ secrets.DEPLOYMENT_USER }}:${{ secrets.DEPLOYMENT_USER }} {}/bootstrap/cache; + fd '.+' ${{ env.releasesDir }} -d 1 | head -n -3 | xargs -d "\n" -I'{}' rm -rf {}; diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml new file mode 100644 index 00000000..bee15adf --- /dev/null +++ b/.github/workflows/phpunit.yml @@ -0,0 +1,68 @@ +name: PHP Unit + +on: + pull_request: + +jobs: + phpunit: + runs-on: ubuntu-latest + + name: PHPUnit test suite + + services: + postgres: + image: postgres:latest + env: + POSTGRES_USER: postgres + POSTGRES_PASSWORD: postgres + POSTGRES_DB: jbukdev_testing + ports: + - 5432:5432 + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Install Node and dependencies + uses: actions/setup-node@v3 + with: + node-version: 18 + cache: 'npm' + - run: npm ci + + - name: Setup PHP with pecl extensions + uses: shivammathur/setup-php@v2 + with: + php-version: '8.1' + extensions: phpredis,imagick + + - name: Copy .env + run: php -r "file_exists('.env') || copy('.env.github', '.env');" + + - name: Get Composer Cache Directory + id: composer-cache + run: | + echo "::set-output name=dir::$(composer config cache-files-dir)" + + - name: Cache composer dependencies + uses: actions/cache@v3 + with: + path: ${{ steps.composer-cache.outputs.dir }} + key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-composer- + + - name: Install Composer Dependencies + run: composer install --quiet --no-ansi --no-interaction --no-progress + + - name: Generate Key + run: php artisan key:generate + + - name: Setup Directory Permissions + run: chmod -R 777 storage bootstrap/cache + + - name: Setup Database + run: php artisan migrate + + - name: Execute PHPUnit Tests + run: vendor/bin/phpunit diff --git a/.github/workflows/pint.yml b/.github/workflows/pint.yml new file mode 100644 index 00000000..88893a5f --- /dev/null +++ b/.github/workflows/pint.yml @@ -0,0 +1,38 @@ +name: Laravel Pint + +on: + pull_request: + +jobs: + pint: + runs-on: ubuntu-latest + + name: Laravel Pint + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Setup PHP with pecl extensions + uses: shivammathur/setup-php@v2 + with: + php-version: '8.1' + + - name: Get Composer Cache Directory + id: composer-cache + run: | + echo "::set-output name=dir::$(composer config cache-files-dir)" + + - name: Cache composer dependencies + uses: actions/cache@v3 + with: + path: ${{ steps.composer-cache.outputs.dir }} + key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} + restore-keys: | + ${{ runner.os }}-composer- + + - name: Install Composer Dependencies + run: composer install --quiet --no-ansi --no-interaction --no-progress + + - name: Check Files with Laravel Pint + run: vendor/bin/pint --test diff --git a/.gitignore b/.gitignore index a0c2459a..e2bdbaea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,24 +1,21 @@ -/.phpunit.cache /node_modules -/public/build -/public/coverage -/public/hot -/public/files -/public/storage /storage/*.key /vendor .env -.env.backup -.env.production .phpunit.result.cache Homestead.json Homestead.yaml -auth.json npm-debug.log yarn-error.log -/.fleet /.idea -/.vscode -ray.php -/public/gpg.key -/public/assets/img/favicon.png +/lsp +.phpstorm.meta.php +_ide_helper.php +# Custom paths in /public +/public/coverage +/public/hot +/public/storage +/public/fonts +/public/files +/public/keybase.txt +/public/assets/*.map diff --git a/.styleci.yml b/.styleci.yml new file mode 100644 index 00000000..0fb4a09b --- /dev/null +++ b/.styleci.yml @@ -0,0 +1,8 @@ +preset: laravel + +disabled: + - concat_without_spaces + - single_import_per_statement + +finder: + path: app/ diff --git a/.stylelintrc b/.stylelintrc index a9a9091b..a4bf8d51 100644 --- a/.stylelintrc +++ b/.stylelintrc @@ -1,3 +1,6 @@ { - "extends": ["stylelint-config-standard"] + "extends": ["stylelint-config-standard"], + "rules": { + "indentation": 4 + } } diff --git a/app/CommonMark/Generators/MentionGenerator.php b/app/CommonMark/Generators/ContactMentionGenerator.php similarity index 84% rename from app/CommonMark/Generators/MentionGenerator.php rename to app/CommonMark/Generators/ContactMentionGenerator.php index 2ac1a797..507f2a0f 100644 --- a/app/CommonMark/Generators/MentionGenerator.php +++ b/app/CommonMark/Generators/ContactMentionGenerator.php @@ -8,7 +8,7 @@ use League\CommonMark\Extension\Mention\Generator\MentionGeneratorInterface; use League\CommonMark\Extension\Mention\Mention; use League\CommonMark\Node\Inline\AbstractInline; -class MentionGenerator implements MentionGeneratorInterface +class ContactMentionGenerator implements MentionGeneratorInterface { public function generateMention(Mention $mention): ?AbstractInline { diff --git a/app/CommonMark/Renderers/ContactMentionRenderer.php b/app/CommonMark/Renderers/ContactMentionRenderer.php new file mode 100644 index 00000000..f227f121 --- /dev/null +++ b/app/CommonMark/Renderers/ContactMentionRenderer.php @@ -0,0 +1,24 @@ +getIdentifier())->first(); + + if ($contact === null) { + return '@' . $node->getIdentifier() . ''; + } + + return trim(view('templates.mini-hcard', ['contact' => $contact])->render()); + } +} diff --git a/app/CommonMark/Renderers/MentionRenderer.php b/app/CommonMark/Renderers/MentionRenderer.php deleted file mode 100644 index d970fac8..00000000 --- a/app/CommonMark/Renderers/MentionRenderer.php +++ /dev/null @@ -1,37 +0,0 @@ -getIdentifier())->first(); - - // If we have a contact, render a mini-hcard - if ($contact) { - // rendering a blade template to a string, so canā€™t be an HtmlElement - return trim(view('templates.mini-hcard', ['contact' => $contact])->render()); - } - - // Otherwise, check the link is to the Mastodon profile - $mentionText = $node->getIdentifier(); - $parts = explode('@', $mentionText); - - // This is not [@]handle@instance, so return a Twitter link - if (count($parts) === 1) { - return new HtmlElement('a', ['href' => 'https://twitter.com/' . $parts[0]], '@' . $mentionText); - } - - // Render the Mastodon profile link - return new HtmlElement('a', ['href' => 'https://' . $parts[1] . '/@' . $parts[0]], '@' . $mentionText); - } -} diff --git a/app/Console/Commands/CopyMediaToLocal.php b/app/Console/Commands/CopyMediaToLocal.php deleted file mode 100644 index 2e8d2bce..00000000 --- a/app/Console/Commands/CopyMediaToLocal.php +++ /dev/null @@ -1,69 +0,0 @@ -path; - - $this->info('Processing: ' . $filename); - - // If the file is already saved locally skip to next one - if (Storage::disk('local')->exists('public/' . $filename)) { - $this->info('File already exists locally, skipping'); - - continue; - } - - // Copy the file from S3 to the local filesystem - if (! Storage::disk('s3')->exists($filename)) { - $this->error('File does not exist on S3'); - - continue; - } - $contents = Storage::disk('s3')->get($filename); - Storage::disk('local')->put('public/' . $filename, $contents); - - // Copy -medium and -small versions if they exist - $filenameParts = explode('.', $filename); - $extension = array_pop($filenameParts); - $basename = trim(implode('.', $filenameParts), '.'); - $mediumFilename = $basename . '-medium.' . $extension; - $smallFilename = $basename . '-small.' . $extension; - if (Storage::disk('s3')->exists($mediumFilename)) { - Storage::disk('local')->put('public/' . $mediumFilename, Storage::disk('s3')->get($mediumFilename)); - } - if (Storage::disk('s3')->exists($smallFilename)) { - Storage::disk('local')->put('public/' . $smallFilename, Storage::disk('s3')->get($smallFilename)); - } - } - } -} diff --git a/app/Console/Commands/MigratePlaceDataFromPostgis.php b/app/Console/Commands/MigratePlaceDataFromPostgis.php index 8d5d2c92..9ce93a27 100644 --- a/app/Console/Commands/MigratePlaceDataFromPostgis.php +++ b/app/Console/Commands/MigratePlaceDataFromPostgis.php @@ -26,9 +26,21 @@ class MigratePlaceDataFromPostgis extends Command protected $description = 'Copy Postgis data to normal latitude longitude fields'; /** - * Execute the console command. + * Create a new command instance. + * + * @return void */ - public function handle(): int + public function __construct() + { + parent::__construct(); + } + + /** + * Execute the console command. + * + * @return int + */ + public function handle() { $locationColumn = DB::selectOne(DB::raw(" SELECT EXISTS ( diff --git a/app/Console/Commands/ParseCachedWebMentions.php b/app/Console/Commands/ParseCachedWebMentions.php index a6b29176..6bdd1862 100644 --- a/app/Console/Commands/ParseCachedWebMentions.php +++ b/app/Console/Commands/ParseCachedWebMentions.php @@ -6,7 +6,6 @@ namespace App\Console\Commands; use App\Models\WebMention; use Illuminate\Console\Command; -use Illuminate\Contracts\Filesystem\FileNotFoundException; use Illuminate\FileSystem\FileSystem; class ParseCachedWebMentions extends Command @@ -28,13 +27,13 @@ class ParseCachedWebMentions extends Command /** * Execute the console command. * - * @throws FileNotFoundException + * @return mixed */ - public function handle(FileSystem $filesystem): void + public function handle(FileSystem $filesystem) { $htmlFiles = $filesystem->allFiles(storage_path() . '/HTML'); foreach ($htmlFiles as $file) { - if ($file->getExtension() !== 'backup') { // we donā€™t want to parse `.backup` files + if ($file->getExtension() !== 'backup') { //we donā€™t want to parse `.backup` files $filepath = $file->getPathname(); $this->info('Loading HTML from: ' . $filepath); $html = $filesystem->get($filepath); @@ -50,6 +49,9 @@ class ParseCachedWebMentions extends Command /** * Determine the source URL from a filename. + * + * @param string + * @return string */ private function urlFromFilename(string $filepath): string { diff --git a/app/Console/Commands/ReDownloadWebMentions.php b/app/Console/Commands/ReDownloadWebMentions.php index c6452ba9..2c5c18e0 100644 --- a/app/Console/Commands/ReDownloadWebMentions.php +++ b/app/Console/Commands/ReDownloadWebMentions.php @@ -25,9 +25,21 @@ class ReDownloadWebMentions extends Command protected $description = 'Redownload the HTML content of webmentions'; /** - * Execute the console command. + * Create a new command instance. + * + * @return void */ - public function handle(): void + public function __construct() + { + parent::__construct(); + } + + /** + * Execute the console command. + * + * @return mixed + */ + public function handle() { $webmentions = WebMention::all(); foreach ($webmentions as $webmention) { diff --git a/app/Console/Commands/UpdateWebmentionsRelationship.php b/app/Console/Commands/UpdateWebmentionsRelationship.php deleted file mode 100644 index f5bc1114..00000000 --- a/app/Console/Commands/UpdateWebmentionsRelationship.php +++ /dev/null @@ -1,36 +0,0 @@ -where('commentable_type', '=', 'App\Model\Note') - ->update(['commentable_type' => Note::class]); - - $this->info('All webmentions updated to relate to the correct note model class'); - } -} diff --git a/app/Console/Kernel.php b/app/Console/Kernel.php index 432844ad..e9eed3a0 100644 --- a/app/Console/Kernel.php +++ b/app/Console/Kernel.php @@ -8,20 +8,35 @@ use Illuminate\Foundation\Console\Kernel as ConsoleKernel; class Kernel extends ConsoleKernel { /** - * Define the application's command schedule. + * The Artisan commands provided by your application. + * + * @var array */ - protected function schedule(Schedule $schedule): void + protected $commands = [ + Commands\ParseCachedWebMentions::class, + Commands\ReDownloadWebMentions::class, + ]; + + /** + * Define the application's command schedule. + * + * @param \Illuminate\Console\Scheduling\Schedule $schedule + * @return void + * @codeCoverageIgnore + */ + protected function schedule(Schedule $schedule) { $schedule->command('horizon:snapshot')->everyFiveMinutes(); - $schedule->command('cache:prune-stale-tags')->hourly(); } /** * Register the commands for the application. + * + * @return void */ - protected function commands(): void + protected function commands() { - $this->load(__DIR__.'/Commands'); + $this->load(__DIR__ . '/Commands'); require base_path('routes/console.php'); } diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php index cb48444a..eed4b776 100644 --- a/app/Exceptions/Handler.php +++ b/app/Exceptions/Handler.php @@ -2,18 +2,104 @@ namespace App\Exceptions; +use Exception; +use GuzzleHttp\Client; +use Illuminate\Database\Eloquent\ModelNotFoundException; use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; +use Illuminate\Http\Request; +use Illuminate\Http\Response; +use Illuminate\Session\TokenMismatchException; +use Illuminate\Support\Facades\Route; +use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Throwable; +/** + * @codeCoverageIgnore + */ class Handler extends ExceptionHandler { /** - * Register the exception handling callbacks for the application. + * A list of the exception types that are not reported. + * + * @var array */ - public function register(): void + protected $dontReport = [ + NotFoundHttpException::class, + ModelNotFoundException::class, + ]; + + /** + * A list of the inputs that are never flashed for validation exceptions. + * + * @var array + */ + protected $dontFlash = [ + 'password', + 'password_confirmation', + ]; + + /** + * Report or log an exception. + * + * This is a great spot to send exceptions to Sentry, Bugsnag, etc. + * + * @param Throwable $throwable + * @return void + * + * @throws Exception + * @throws Throwable + */ + public function report(Throwable $throwable) { - $this->reportable(function (Throwable $_e) { - // - }); + parent::report($throwable); + + if ($this->shouldReport($throwable)) { + $guzzle = new Client([ + 'headers' => [ + 'Content-Type' => 'application/json', + ], + ]); + + $exceptionName = get_class($throwable) ?? 'Unknown Exception'; + $title = $exceptionName . ': ' . $throwable->getMessage(); + + $guzzle->post( + config('logging.slack'), + [ + 'body' => json_encode([ + 'attachments' => [[ + 'fallback' => 'There was an exception.', + 'pretext' => 'There was an exception.', + 'color' => '#d00000', + 'author_name' => app()->environment(), + 'author_link' => config('app.url'), + 'fields' => [[ + 'title' => $title, + 'value' => request()->method() . ' ' . request()->fullUrl(), + ]], + 'ts' => time(), + ]], + ]), + ] + ); + } + } + + /** + * Render an exception into an HTTP response. + * + * @param Request $request + * @param Throwable $throwable + * @return Response + * + * @throws Throwable + */ + public function render($request, Throwable $throwable) + { + if ($throwable instanceof TokenMismatchException) { + Route::getRoutes()->match($request); + } + + return parent::render($request, $throwable); } } diff --git a/app/Exceptions/InternetArchiveException.php b/app/Exceptions/InternetArchiveException.php index 99d5cab7..7e810fea 100644 --- a/app/Exceptions/InternetArchiveException.php +++ b/app/Exceptions/InternetArchiveException.php @@ -2,4 +2,6 @@ namespace App\Exceptions; -class InternetArchiveException extends \Exception {} +class InternetArchiveException extends \Exception +{ +} diff --git a/app/Exceptions/InvalidTokenScopeException.php b/app/Exceptions/InvalidTokenScopeException.php deleted file mode 100644 index 5966bccd..00000000 --- a/app/Exceptions/InvalidTokenScopeException.php +++ /dev/null @@ -1,7 +0,0 @@ -hasFile('article')) { $file = request()->file('article')->openFile(); $content = $file->fread($file->getSize()); diff --git a/app/Http/Controllers/Admin/BioController.php b/app/Http/Controllers/Admin/BioController.php deleted file mode 100644 index c760e12c..00000000 --- a/app/Http/Controllers/Admin/BioController.php +++ /dev/null @@ -1,32 +0,0 @@ - $bio, - ]); - } - - public function update(Request $request): RedirectResponse - { - $bio = Bio::firstOrNew(); - $bio->content = $request->input('content'); - $bio->save(); - - return redirect()->route('admin.bio.show'); - } -} diff --git a/app/Http/Controllers/Admin/ClientsController.php b/app/Http/Controllers/Admin/ClientsController.php index 38524b62..fd12cba9 100644 --- a/app/Http/Controllers/Admin/ClientsController.php +++ b/app/Http/Controllers/Admin/ClientsController.php @@ -7,12 +7,15 @@ namespace App\Http\Controllers\Admin; use App\Http\Controllers\Controller; use App\Models\MicropubClient; use Illuminate\Http\RedirectResponse; +use Illuminate\Http\Request; use Illuminate\View\View; class ClientsController extends Controller { /** * Show a list of known clients. + * + * @return \Illuminate\View\View */ public function index(): View { @@ -23,6 +26,8 @@ class ClientsController extends Controller /** * Show form to add a client name. + * + * @return \Illuminate\View\View */ public function create(): View { @@ -31,6 +36,8 @@ class ClientsController extends Controller /** * Process the request to adda new client name. + * + * @return \Illuminate\Http\RedirectResponse */ public function store(): RedirectResponse { @@ -44,6 +51,9 @@ class ClientsController extends Controller /** * Show a form to edit a client name. + * + * @param int $clientId + * @return \Illuminate\View\View */ public function edit(int $clientId): View { @@ -58,6 +68,9 @@ class ClientsController extends Controller /** * Process the request to edit a client name. + * + * @param int $clientId + * @return \Illuminate\Http\RedirectResponse */ public function update(int $clientId): RedirectResponse { @@ -71,6 +84,9 @@ class ClientsController extends Controller /** * Process a request to delete a client. + * + * @param int $clientId + * @return \Illuminate\Http\RedirectResponse */ public function destroy(int $clientId): RedirectResponse { diff --git a/app/Http/Controllers/Admin/ContactsController.php b/app/Http/Controllers/Admin/ContactsController.php index eb45320c..fe0c3cfc 100644 --- a/app/Http/Controllers/Admin/ContactsController.php +++ b/app/Http/Controllers/Admin/ContactsController.php @@ -9,6 +9,7 @@ use App\Models\Contact; use GuzzleHttp\Client; use Illuminate\Filesystem\Filesystem; use Illuminate\Http\RedirectResponse; +use Illuminate\Http\Request; use Illuminate\Support\Arr; use Illuminate\View\View; @@ -16,6 +17,8 @@ class ContactsController extends Controller { /** * List the currect contacts that can be edited. + * + * @return \Illuminate\View\View */ public function index(): View { @@ -26,6 +29,8 @@ class ContactsController extends Controller /** * Display the form to add a new contact. + * + * @return \Illuminate\View\View */ public function create(): View { @@ -34,10 +39,12 @@ class ContactsController extends Controller /** * Process the request to add a new contact. + * + * @return \Illuminate\Http\RedirectResponse */ public function store(): RedirectResponse { - $contact = new Contact; + $contact = new Contact(); $contact->name = request()->input('name'); $contact->nick = request()->input('nick'); $contact->homepage = request()->input('homepage'); @@ -50,6 +57,9 @@ class ContactsController extends Controller /** * Show the form to edit an existing contact. + * + * @param int $contactId + * @return \Illuminate\View\View */ public function edit(int $contactId): View { @@ -62,6 +72,9 @@ class ContactsController extends Controller * Process the request to edit a contact. * * @todo Allow saving profile pictures for people without homepages + * + * @param int $contactId + * @return \Illuminate\Http\RedirectResponse */ public function update(int $contactId): RedirectResponse { @@ -76,7 +89,7 @@ class ContactsController extends Controller if (request()->hasFile('avatar') && (request()->input('homepage') != '')) { $dir = parse_url(request()->input('homepage'), PHP_URL_HOST); $destination = public_path() . '/assets/profile-images/' . $dir; - $filesystem = new Filesystem; + $filesystem = new Filesystem(); if ($filesystem->isDirectory($destination) === false) { $filesystem->makeDirectory($destination); } @@ -88,6 +101,9 @@ class ContactsController extends Controller /** * Process the request to delete a contact. + * + * @param int $contactId + * @return \Illuminate\Http\RedirectResponse */ public function destroy(int $contactId): RedirectResponse { @@ -103,6 +119,7 @@ class ContactsController extends Controller * This method attempts to find the microformat marked-up profile image * from a given homepage and save it accordingly * + * @param int $contactId * @return \Illuminate\Http\RedirectResponse|\Illuminate\View\View */ public function getAvatar(int $contactId) @@ -136,7 +153,7 @@ class ContactsController extends Controller } if ($avatar !== null) { $directory = public_path() . '/assets/profile-images/' . parse_url($contact->homepage, PHP_URL_HOST); - $filesystem = new Filesystem; + $filesystem = new Filesystem(); if ($filesystem->isDirectory($directory) === false) { $filesystem->makeDirectory($directory); } diff --git a/app/Http/Controllers/Admin/HomeController.php b/app/Http/Controllers/Admin/HomeController.php index ae4f4d36..ee10e4dc 100644 --- a/app/Http/Controllers/Admin/HomeController.php +++ b/app/Http/Controllers/Admin/HomeController.php @@ -11,6 +11,8 @@ class HomeController extends Controller { /** * Show the homepage of the admin CP. + * + * @return \Illuminate\View\View */ public function welcome(): View { diff --git a/app/Http/Controllers/Admin/LikesController.php b/app/Http/Controllers/Admin/LikesController.php index 9ebd7e74..102c281e 100644 --- a/app/Http/Controllers/Admin/LikesController.php +++ b/app/Http/Controllers/Admin/LikesController.php @@ -14,6 +14,8 @@ class LikesController extends Controller { /** * List the likes that can be edited. + * + * @return \Illuminate\View\View */ public function index(): View { @@ -24,6 +26,8 @@ class LikesController extends Controller /** * Show the form to make a new like. + * + * @return \Illuminate\View\View */ public function create(): View { @@ -32,6 +36,8 @@ class LikesController extends Controller /** * Process a request to make a new like. + * + * @return \Illuminate\Http\RedirectResponse */ public function store(): RedirectResponse { @@ -45,6 +51,9 @@ class LikesController extends Controller /** * Display the form to edit a specific like. + * + * @param int $likeId + * @return \Illuminate\View\View */ public function edit(int $likeId): View { @@ -58,6 +67,9 @@ class LikesController extends Controller /** * Process a request to edit a like. + * + * @param int $likeId + * @return \Illuminate\Http\RedirectResponse */ public function update(int $likeId): RedirectResponse { @@ -71,6 +83,9 @@ class LikesController extends Controller /** * Process the request to delete a like. + * + * @param int $likeId + * @return \Illuminate\Http\RedirectResponse */ public function destroy(int $likeId): RedirectResponse { diff --git a/app/Http/Controllers/Admin/NotesController.php b/app/Http/Controllers/Admin/NotesController.php index c6ed93ba..75a15231 100644 --- a/app/Http/Controllers/Admin/NotesController.php +++ b/app/Http/Controllers/Admin/NotesController.php @@ -15,6 +15,8 @@ class NotesController extends Controller { /** * List the notes that can be edited. + * + * @return \Illuminate\View\View */ public function index(): View { @@ -28,6 +30,8 @@ class NotesController extends Controller /** * Show the form to make a new note. + * + * @return \Illuminate\View\View */ public function create(): View { @@ -36,12 +40,14 @@ class NotesController extends Controller /** * Process a request to make a new note. + * + * @return \Illuminate\Http\RedirectResponse */ - public function store(Request $request): RedirectResponse + public function store(): RedirectResponse { Note::create([ - 'in_reply_to' => $request->input('in-reply-to'), - 'note' => $request->input('content'), + 'in-reply-to' => request()->input('in-reply-to'), + 'note' => request()->input('content'), ]); return redirect('/admin/notes'); @@ -49,6 +55,9 @@ class NotesController extends Controller /** * Display the form to edit a specific note. + * + * @param int $noteId + * @return \Illuminate\View\View */ public function edit(int $noteId): View { @@ -61,10 +70,13 @@ class NotesController extends Controller /** * Process a request to edit a note. Easy since this can only be done * from the admin CP. + * + * @param int $noteId + * @return \Illuminate\Http\RedirectResponse */ public function update(int $noteId): RedirectResponse { - // update note data + //update note data $note = Note::findOrFail($noteId); $note->note = request()->input('content'); $note->in_reply_to = request()->input('in-reply-to'); @@ -79,6 +91,9 @@ class NotesController extends Controller /** * Delete the note. + * + * @param int $noteId + * @return \Illuminate\Http\RedirectResponse */ public function destroy(int $noteId): RedirectResponse { diff --git a/app/Http/Controllers/Admin/PasskeysController.php b/app/Http/Controllers/Admin/PasskeysController.php deleted file mode 100644 index 9f635f10..00000000 --- a/app/Http/Controllers/Admin/PasskeysController.php +++ /dev/null @@ -1,326 +0,0 @@ -user(); - $passkeys = $user->passkey; - - return view('admin.passkeys.index', compact('passkeys')); - } - - /** - * @throws RandomException - * @throws \JsonException - */ - public function getCreateOptions(Request $request): JsonResponse - { - /** @var User $user */ - $user = auth()->user(); - - // RP Entity i.e. the application - $rpEntity = PublicKeyCredentialRpEntity::create( - name: config('app.name'), - id: config('app.url'), - ); - - // User Entity - $userEntity = PublicKeyCredentialUserEntity::create( - name: $user->name, - id: (string) $user->id, - displayName: $user->name, - ); - - // Challenge - $challenge = random_bytes(16); - - // List of supported public key parameters - $pubKeyCredParams = collect([ - Algorithms::COSE_ALGORITHM_EDDSA, - Algorithms::COSE_ALGORITHM_ES256, - Algorithms::COSE_ALGORITHM_RS256, - ])->map( - fn ($algorithm) => PublicKeyCredentialParameters::create('public-key', $algorithm) - )->toArray(); - - $authenticatorSelectionCriteria = AuthenticatorSelectionCriteria::create( - userVerification: AuthenticatorSelectionCriteria::USER_VERIFICATION_REQUIREMENT_REQUIRED, - residentKey: AuthenticatorSelectionCriteria::RESIDENT_KEY_REQUIREMENT_REQUIRED, - ); - - $publicKeyCredentialCreationOptions = PublicKeyCredentialCreationOptions::create( - rp: $rpEntity, - user: $userEntity, - challenge: $challenge, - pubKeyCredParams: $pubKeyCredParams, - authenticatorSelection: $authenticatorSelectionCriteria, - attestation: PublicKeyCredentialCreationOptions::ATTESTATION_CONVEYANCE_PREFERENCE_NONE - ); - - $attestationStatementSupportManager = new AttestationStatementSupportManager; - $attestationStatementSupportManager->add(new NoneAttestationStatementSupport); - $webauthnSerializerFactory = new WebauthnSerializerFactory( - attestationStatementSupportManager: $attestationStatementSupportManager - ); - $webauthnSerializer = $webauthnSerializerFactory->create(); - $publicKeyCredentialCreationOptions = $webauthnSerializer->serialize( - data: $publicKeyCredentialCreationOptions, - format: 'json' - ); - - $request->session()->put('create_options', $publicKeyCredentialCreationOptions); - - return JsonResponse::fromJsonString($publicKeyCredentialCreationOptions); - } - - /** - * @throws Throwable - * @throws WebauthnException - * @throws \JsonException - */ - public function create(Request $request): JsonResponse - { - /** @var User $user */ - $user = auth()->user(); - - $publicKeyCredentialCreationOptionsData = session('create_options'); - // Unset session data to mitigate replay attacks - $request->session()->forget('create_options'); - if (empty($publicKeyCredentialCreationOptionsData)) { - throw new WebAuthnException('No public key credential request options found'); - } - - $attestationStatementSupportManager = new AttestationStatementSupportManager; - $attestationStatementSupportManager->add(new NoneAttestationStatementSupport); - $webauthnSerializerFactory = new WebauthnSerializerFactory( - attestationStatementSupportManager: $attestationStatementSupportManager - ); - $webauthnSerializer = $webauthnSerializerFactory->create(); - - $publicKeyCredential = $webauthnSerializer->deserialize( - json_encode($request->all(), JSON_THROW_ON_ERROR), - PublicKeyCredential::class, - 'json' - ); - - if (! $publicKeyCredential->response instanceof AuthenticatorAttestationResponse) { - throw new WebAuthnException('Invalid response type'); - } - - $algorithmManager = new Manager; - $algorithmManager->add(new Ed25519); - $algorithmManager->add(new ES256); - $algorithmManager->add(new RS256); - - $ceremonyStepManagerFactory = new CeremonyStepManagerFactory; - $ceremonyStepManagerFactory->setAlgorithmManager($algorithmManager); - $ceremonyStepManagerFactory->setAttestationStatementSupportManager( - $attestationStatementSupportManager - ); - $ceremonyStepManagerFactory->setExtensionOutputCheckerHandler( - ExtensionOutputCheckerHandler::create() - ); - $allowedOrigins = []; - if (App::environment('local', 'development')) { - $allowedOrigins = [config('app.url')]; - } - $ceremonyStepManagerFactory->setAllowedOrigins($allowedOrigins); - - $authenticatorAttestationResponseValidator = AuthenticatorAttestationResponseValidator::create( - ceremonyStepManager: $ceremonyStepManagerFactory->creationCeremony() - ); - - $publicKeyCredentialCreationOptions = $webauthnSerializer->deserialize( - $publicKeyCredentialCreationOptionsData, - PublicKeyCredentialCreationOptions::class, - 'json' - ); - - $publicKeyCredentialSource = $authenticatorAttestationResponseValidator->check( - authenticatorAttestationResponse: $publicKeyCredential->response, - publicKeyCredentialCreationOptions: $publicKeyCredentialCreationOptions, - host: config('app.url') - ); - - $user->passkey()->create([ - 'passkey_id' => Base64UrlSafe::encodeUnpadded($publicKeyCredentialSource->publicKeyCredentialId), - 'passkey' => json_encode($publicKeyCredentialSource, JSON_THROW_ON_ERROR), - ]); - - return response()->json([ - 'success' => true, - 'message' => 'Passkey created successfully', - ]); - } - - /** - * @throws RandomException - * @throws \JsonException - */ - public function getRequestOptions(Request $request): JsonResponse - { - $publicKeyCredentialRequestOptions = PublicKeyCredentialRequestOptions::create( - challenge: random_bytes(16), - userVerification: PublicKeyCredentialRequestOptions::USER_VERIFICATION_REQUIREMENT_REQUIRED - ); - - $attestationStatementSupportManager = AttestationStatementSupportManager::create(); - $attestationStatementSupportManager->add(NoneAttestationStatementSupport::create()); - $factory = new WebauthnSerializerFactory( - attestationStatementSupportManager: $attestationStatementSupportManager - ); - $serializer = $factory->create(); - $publicKeyCredentialRequestOptions = $serializer->serialize(data: $publicKeyCredentialRequestOptions, format: 'json'); - - $request->session()->put('request_options', $publicKeyCredentialRequestOptions); - - return JsonResponse::fromJsonString($publicKeyCredentialRequestOptions); - } - - /** - * @throws \JsonException - */ - public function login(Request $request): JsonResponse - { - $requestOptions = session('request_options'); - $request->session()->forget('request_options'); - - if (empty($requestOptions)) { - return response()->json([ - 'success' => false, - 'message' => 'No request options found', - ], 400); - } - - $attestationStatementSupportManager = new AttestationStatementSupportManager; - $attestationStatementSupportManager->add(new NoneAttestationStatementSupport); - - $webauthnSerializerFactory = new WebauthnSerializerFactory( - attestationStatementSupportManager: $attestationStatementSupportManager - ); - $webauthnSerializer = $webauthnSerializerFactory->create(); - - $publicKeyCredential = $webauthnSerializer->deserialize( - json_encode($request->all(), JSON_THROW_ON_ERROR), - PublicKeyCredential::class, - 'json' - ); - - if (! $publicKeyCredential->response instanceof AuthenticatorAssertionResponse) { - return response()->json([ - 'success' => false, - 'message' => 'Invalid response type', - ], 400); - } - - $passkey = Passkey::firstWhere('passkey_id', $publicKeyCredential->id); - if (! $passkey) { - return response()->json([ - 'success' => false, - 'message' => 'Passkey not found', - ], 404); - } - - $publicKeyCredentialSource = $webauthnSerializer->deserialize( - $passkey->passkey, - PublicKeyCredentialSource::class, - 'json' - ); - - $algorithmManager = new Manager; - $algorithmManager->add(new Ed25519); - $algorithmManager->add(new ES256); - $algorithmManager->add(new RS256); - - $attestationStatementSupportManager = new AttestationStatementSupportManager; - $attestationStatementSupportManager->add(new NoneAttestationStatementSupport); - - $ceremonyStepManagerFactory = new CeremonyStepManagerFactory; - $ceremonyStepManagerFactory->setAlgorithmManager($algorithmManager); - $ceremonyStepManagerFactory->setAttestationStatementSupportManager( - $attestationStatementSupportManager - ); - $ceremonyStepManagerFactory->setExtensionOutputCheckerHandler( - ExtensionOutputCheckerHandler::create() - ); - $allowedOrigins = []; - if (App::environment('local', 'development')) { - $allowedOrigins = [config('app.url')]; - } - $ceremonyStepManagerFactory->setAllowedOrigins($allowedOrigins); - - $authenticatorAssertionResponseValidator = AuthenticatorAssertionResponseValidator::create( - ceremonyStepManager: $ceremonyStepManagerFactory->requestCeremony() - ); - - $publicKeyCredentialRequestOptions = $webauthnSerializer->deserialize( - $requestOptions, - PublicKeyCredentialRequestOptions::class, - 'json' - ); - - try { - $authenticatorAssertionResponseValidator->check( - publicKeyCredentialSource: $publicKeyCredentialSource, - authenticatorAssertionResponse: $publicKeyCredential->response, - publicKeyCredentialRequestOptions: $publicKeyCredentialRequestOptions, - host: config('app.url'), - userHandle: null, - ); - } catch (Throwable) { - return response()->json([ - 'success' => false, - 'message' => 'Passkey could not be verified', - ], 500); - } - - $user = User::find($passkey->user_id); - Auth::login($user); - - return response()->json([ - 'success' => true, - 'message' => 'Passkey verified successfully', - ]); - } -} diff --git a/app/Http/Controllers/Admin/PlacesController.php b/app/Http/Controllers/Admin/PlacesController.php index e5e82bcd..e1025e2f 100644 --- a/app/Http/Controllers/Admin/PlacesController.php +++ b/app/Http/Controllers/Admin/PlacesController.php @@ -21,6 +21,8 @@ class PlacesController extends Controller /** * List the places that can be edited. + * + * @return View */ public function index(): View { @@ -31,6 +33,8 @@ class PlacesController extends Controller /** * Show the form to make a new place. + * + * @return View */ public function create(): View { @@ -39,6 +43,8 @@ class PlacesController extends Controller /** * Process a request to make a new place. + * + * @return RedirectResponse */ public function store(): RedirectResponse { @@ -56,6 +62,9 @@ class PlacesController extends Controller /** * Display the form to edit a specific place. + * + * @param int $placeId + * @return View */ public function edit(int $placeId): View { @@ -66,6 +75,9 @@ class PlacesController extends Controller /** * Process a request to edit a place. + * + * @param int $placeId + * @return RedirectResponse */ public function update(int $placeId): RedirectResponse { @@ -82,6 +94,9 @@ class PlacesController extends Controller /** * List the places we can merge with the current place. + * + * @param int $placeId + * @return View */ public function mergeIndex(int $placeId): View { @@ -99,6 +114,10 @@ class PlacesController extends Controller /** * Show a form for merging two specific places. + * + * @param int $placeId1 + * @param int $placeId2 + * @return View */ public function mergeEdit(int $placeId1, int $placeId2): View { @@ -110,6 +129,8 @@ class PlacesController extends Controller /** * Process the request to merge two places. + * + * @return RedirectResponse */ public function mergeStore(): RedirectResponse { diff --git a/app/Http/Controllers/Admin/SyndicationTargetsController.php b/app/Http/Controllers/Admin/SyndicationTargetsController.php index dc14a2d2..c71140ee 100644 --- a/app/Http/Controllers/Admin/SyndicationTargetsController.php +++ b/app/Http/Controllers/Admin/SyndicationTargetsController.php @@ -14,6 +14,8 @@ class SyndicationTargetsController extends Controller { /** * Show a list of known syndication targets. + * + * @return View */ public function index(): View { @@ -24,6 +26,8 @@ class SyndicationTargetsController extends Controller /** * Show form to add a syndication target. + * + * @return View */ public function create(): View { @@ -32,6 +36,9 @@ class SyndicationTargetsController extends Controller /** * Process the request to adda new syndication target. + * + * @param Request $request + * @return RedirectResponse */ public function store(Request $request): RedirectResponse { @@ -53,6 +60,9 @@ class SyndicationTargetsController extends Controller /** * Show a form to edit a syndication target. + * + * @param SyndicationTarget $syndicationTarget + * @return View */ public function edit(SyndicationTarget $syndicationTarget): View { @@ -63,6 +73,10 @@ class SyndicationTargetsController extends Controller /** * Process the request to edit a client name. + * + * @param Request $request + * @param SyndicationTarget $syndicationTarget + * @return RedirectResponse */ public function update(Request $request, SyndicationTarget $syndicationTarget): RedirectResponse { @@ -84,6 +98,9 @@ class SyndicationTargetsController extends Controller /** * Process a request to delete a client. + * + * @param SyndicationTarget $syndicationTarget + * @return RedirectResponse */ public function destroy(SyndicationTarget $syndicationTarget): RedirectResponse { diff --git a/app/Http/Controllers/ArticlesController.php b/app/Http/Controllers/ArticlesController.php index 9ab860d7..811ddc38 100644 --- a/app/Http/Controllers/ArticlesController.php +++ b/app/Http/Controllers/ArticlesController.php @@ -14,21 +14,30 @@ class ArticlesController extends Controller { /** * Show all articles (with pagination). + * + * @param int|null $year + * @param int|null $month + * @return View */ - public function index(?int $year = null, ?int $month = null): View + public function index(int $year = null, int $month = null): View { $articles = Article::where('published', '1') - ->date($year, $month) - ->orderBy('updated_at', 'desc') - ->simplePaginate(5); + ->date($year, $month) + ->orderBy('updated_at', 'desc') + ->simplePaginate(5); return view('articles.index', compact('articles')); } /** * Show a single article. + * + * @param int $year + * @param int $month + * @param string $slug + * @return RedirectResponse|View */ - public function show(int $year, int $month, string $slug): RedirectResponse|View + public function show(int $year, int $month, string $slug) { try { $article = Article::where('titleurl', $slug)->firstOrFail(); @@ -47,7 +56,11 @@ class ArticlesController extends Controller } /** - * We only have the ID, work out post title, year and month and redirect to it. + * We only have the ID, work out post title, year and month + * and redirect to it. + * + * @param string $idFromUrl + * @return RedirectResponse */ public function onlyIdInUrl(string $idFromUrl): RedirectResponse { diff --git a/app/Http/Controllers/AuthController.php b/app/Http/Controllers/AuthController.php index bd0022d6..6efd237e 100644 --- a/app/Http/Controllers/AuthController.php +++ b/app/Http/Controllers/AuthController.php @@ -5,7 +5,6 @@ declare(strict_types=1); namespace App\Http\Controllers; use Illuminate\Http\RedirectResponse; -use Illuminate\Http\Request; use Illuminate\Support\Facades\Auth; use Illuminate\View\View; @@ -13,8 +12,10 @@ class AuthController extends Controller { /** * Show the login form. + * + * @return View|RedirectResponse */ - public function showLogin(): View|RedirectResponse + public function showLogin() { if (Auth::check()) { return redirect('/'); @@ -24,23 +25,28 @@ class AuthController extends Controller } /** - * Log in a user, set a session variable, check credentials against the `.env` file. + * Log in a user, set a session variable, check credentials against + * the .env file. + * + * @return RedirectResponse */ - public function login(Request $request): RedirectResponse + public function login(): RedirectResponse { - $credentials = $request->only('name', 'password'); + $credentials = request()->only('name', 'password'); if (Auth::attempt($credentials, true)) { - return redirect()->intended('/admin'); + return redirect()->intended('/'); } return redirect()->route('login'); } /** - * Show the form to allow a user to log-out. + * Show the form to logout a user. + * + * @return View|RedirectResponse */ - public function showLogout(): View|RedirectResponse + public function showLogout() { if (Auth::check() === false) { // The user is not logged in, just redirect them home @@ -52,6 +58,8 @@ class AuthController extends Controller /** * Log the user out from their current session. + * + * @return RedirectResponse; */ public function logout(): RedirectResponse { diff --git a/app/Http/Controllers/BookmarksController.php b/app/Http/Controllers/BookmarksController.php index b4bb3c13..ee832c05 100644 --- a/app/Http/Controllers/BookmarksController.php +++ b/app/Http/Controllers/BookmarksController.php @@ -11,6 +11,8 @@ class BookmarksController extends Controller { /** * Show the most recent bookmarks. + * + * @return View */ public function index(): View { @@ -21,6 +23,9 @@ class BookmarksController extends Controller /** * Show a single bookmark. + * + * @param Bookmark $bookmark + * @return View */ public function show(Bookmark $bookmark): View { @@ -31,6 +36,9 @@ class BookmarksController extends Controller /** * Show bookmarks tagged with a specific tag. + * + * @param string $tag + * @return View */ public function tagged(string $tag): View { diff --git a/app/Http/Controllers/ContactsController.php b/app/Http/Controllers/ContactsController.php index 280cc3ed..3a46026e 100644 --- a/app/Http/Controllers/ContactsController.php +++ b/app/Http/Controllers/ContactsController.php @@ -12,10 +12,12 @@ class ContactsController extends Controller { /** * Show all the contacts. + * + * @return View */ public function index(): View { - $filesystem = new Filesystem; + $filesystem = new Filesystem(); $contacts = Contact::all(); foreach ($contacts as $contact) { $contact->homepageHost = parse_url($contact->homepage, PHP_URL_HOST); @@ -31,13 +33,16 @@ class ContactsController extends Controller /** * Show a single contact. + * + * @param Contact $contact + * @return View */ public function show(Contact $contact): View { $contact->homepageHost = parse_url($contact->homepage, PHP_URL_HOST); $file = public_path() . '/assets/profile-images/' . $contact->homepageHost . '/image'; - $filesystem = new Filesystem; + $filesystem = new Filesystem(); $image = ($filesystem->exists($file)) ? '/assets/profile-images/' . $contact->homepageHost . '/image' : diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php index 8677cd5c..ce1176dd 100644 --- a/app/Http/Controllers/Controller.php +++ b/app/Http/Controllers/Controller.php @@ -2,7 +2,14 @@ namespace App\Http\Controllers; -abstract class Controller +use Illuminate\Foundation\Auth\Access\AuthorizesRequests; +use Illuminate\Foundation\Bus\DispatchesJobs; +use Illuminate\Foundation\Validation\ValidatesRequests; +use Illuminate\Routing\Controller as BaseController; + +class Controller extends BaseController { - // + use AuthorizesRequests; + use DispatchesJobs; + use ValidatesRequests; } diff --git a/app/Http/Controllers/FeedsController.php b/app/Http/Controllers/FeedsController.php index eb0847a3..a1468cbb 100644 --- a/app/Http/Controllers/FeedsController.php +++ b/app/Http/Controllers/FeedsController.php @@ -13,6 +13,8 @@ class FeedsController extends Controller { /** * Returns the blog RSS feed. + * + * @return Response */ public function blogRss(): Response { @@ -20,24 +22,28 @@ class FeedsController extends Controller $buildDate = $articles->first()->updated_at->toRssString(); return response() - ->view('articles.rss', compact('articles', 'buildDate')) - ->header('Content-Type', 'application/rss+xml; charset=utf-8'); + ->view('articles.rss', compact('articles', 'buildDate')) + ->header('Content-Type', 'application/rss+xml; charset=utf-8'); } /** * Returns the blog Atom feed. + * + * @return Response */ public function blogAtom(): Response { $articles = Article::where('published', '1')->latest('updated_at')->take(20)->get(); return response() - ->view('articles.atom', compact('articles')) - ->header('Content-Type', 'application/atom+xml; charset=utf-8'); + ->view('articles.atom', compact('articles')) + ->header('Content-Type', 'application/atom+xml; charset=utf-8'); } /** * Returns the notes RSS feed. + * + * @return Response */ public function notesRss(): Response { @@ -45,41 +51,39 @@ class FeedsController extends Controller $buildDate = $notes->first()->updated_at->toRssString(); return response() - ->view('notes.rss', compact('notes', 'buildDate')) - ->header('Content-Type', 'application/rss+xml; charset=utf-8'); + ->view('notes.rss', compact('notes', 'buildDate')) + ->header('Content-Type', 'application/rss+xml; charset=utf-8'); } /** * Returns the notes Atom feed. + * + * @return Response */ public function notesAtom(): Response { $notes = Note::latest()->take(20)->get(); return response() - ->view('notes.atom', compact('notes')) - ->header('Content-Type', 'application/atom+xml; charset=utf-8'); + ->view('notes.atom', compact('notes')) + ->header('Content-Type', 'application/atom+xml; charset=utf-8'); } /** @todo sort out return type for json responses */ /** * Returns the blog JSON feed. + * + * @return array */ public function blogJson(): array { $articles = Article::where('published', '1')->latest('updated_at')->take(20)->get(); $data = [ - 'version' => 'https://jsonfeed.org/version/1.1', - 'title' => 'The JSON Feed for ' . config('user.display_name') . 'ā€™s blog', + 'version' => 'https://jsonfeed.org/version/1', + 'title' => 'The JSON Feed for ' . config('app.display_name') . 'ā€™s blog', 'home_page_url' => config('app.url') . '/blog', 'feed_url' => config('app.url') . '/blog/feed.json', - 'authors' => [ - [ - 'name' => config('user.display_name'), - 'url' => config('app.url'), - ], - ], 'items' => [], ]; @@ -91,6 +95,9 @@ class FeedsController extends Controller 'content_html' => $article->main, 'date_published' => $article->created_at->tz('UTC')->toRfc3339String(), 'date_modified' => $article->updated_at->tz('UTC')->toRfc3339String(), + 'author' => [ + 'name' => config('app.display_name'), + ], ]; } @@ -99,35 +106,31 @@ class FeedsController extends Controller /** * Returns the notes JSON feed. + * + * @return array */ - public function notesJson(): array + public function notesJson() { - $notes = Note::latest()->with('media', 'place', 'tags')->take(20)->get(); + $notes = Note::latest()->take(20)->get(); $data = [ - 'version' => 'https://jsonfeed.org/version/1.1', - 'title' => 'The JSON Feed for ' . config('user.display_name') . 'ā€™s notes', + 'version' => 'https://jsonfeed.org/version/1', + 'title' => 'The JSON Feed for ' . config('app.display_name') . 'ā€™s notes', 'home_page_url' => config('app.url') . '/notes', 'feed_url' => config('app.url') . '/notes/feed.json', - 'authors' => [ - [ - 'name' => config('user.display_name'), - 'url' => config('app.url'), - ], - ], 'items' => [], ]; foreach ($notes as $key => $note) { $data['items'][$key] = [ - 'id' => $note->uri, - 'url' => $note->uri, - 'content_text' => $note->content, + 'id' => $note->longurl, + 'url' => $note->longurl, + 'content_html' => $note->content, 'date_published' => $note->created_at->tz('UTC')->toRfc3339String(), 'date_modified' => $note->updated_at->tz('UTC')->toRfc3339String(), + 'author' => [ + 'name' => config('app.display_name'), + ], ]; - if ($note->tags->count() > 0) { - $data['items'][$key]['tags'] = implode(',', $note->tags->pluck('tag')->toArray()); - } } return $data; @@ -135,6 +138,8 @@ class FeedsController extends Controller /** * Returns the blog JF2 feed. + * + * @return JsonResponse */ public function blogJf2(): JsonResponse { @@ -160,8 +165,8 @@ class FeedsController extends Controller 'url' => url('/blog'), 'author' => [ 'type' => 'card', - 'name' => config('user.display_name'), - 'url' => config('app.url'), + 'name' => config('user.displayname'), + 'url' => config('app.longurl'), ], 'children' => $items, ], 200, [ @@ -171,6 +176,8 @@ class FeedsController extends Controller /** * Returns the notes JF2 feed. + * + * @return JsonResponse */ public function notesJf2(): JsonResponse { @@ -180,8 +187,8 @@ class FeedsController extends Controller $items[] = [ 'type' => 'entry', 'published' => $note->created_at, - 'uid' => $note->uri, - 'url' => $note->uri, + 'uid' => $note->longurl, + 'url' => $note->longurl, 'content' => [ 'text' => $note->getRawOriginal('note'), 'html' => $note->note, @@ -196,8 +203,8 @@ class FeedsController extends Controller 'url' => url('/notes'), 'author' => [ 'type' => 'card', - 'name' => config('user.display_name'), - 'url' => config('app.url'), + 'name' => config('user.displayname'), + 'url' => config('app.longurl'), ], 'children' => $items, ], 200, [ diff --git a/app/Http/Controllers/FrontPageController.php b/app/Http/Controllers/FrontPageController.php index 19537663..05731663 100644 --- a/app/Http/Controllers/FrontPageController.php +++ b/app/Http/Controllers/FrontPageController.php @@ -3,10 +3,10 @@ namespace App\Http\Controllers; use App\Models\Article; -use App\Models\Bio; use App\Models\Bookmark; use App\Models\Like; use App\Models\Note; +use App\Services\ActivityStreamsService; use Illuminate\Http\Response; use Illuminate\View\View; @@ -14,20 +14,18 @@ class FrontPageController extends Controller { /** * Show all the recent activity. + * + * @return Response|View */ - public function index(): Response|View + public function index() { - $notes = Note::latest()->with(['media', 'client', 'place'])->withCount(['webmentions AS replies' => function ($query) { - $query->where('type', 'in-reply-to'); - }]) - ->withCount(['webmentions AS likes' => function ($query) { - $query->where('type', 'like-of'); - }]) - ->withCount(['webmentions AS reposts' => function ($query) { - $query->where('type', 'repost-of'); - }])->get(); + if (request()->wantsActivityStream()) { + return (new ActivityStreamsService())->siteOwnerResponse(); + } + + $notes = Note::latest()->get(); $articles = Article::latest()->get(); - $bookmarks = Bookmark::latest()->with('tags')->get(); + $bookmarks = Bookmark::latest()->get(); $likes = Like::latest()->get(); $items = collect($notes) @@ -37,11 +35,8 @@ class FrontPageController extends Controller ->sortByDesc('updated_at') ->paginate(10); - $bio = Bio::first()?->content; - return view('front-page', [ 'items' => $items, - 'bio' => $bio, ]); } } diff --git a/app/Http/Controllers/IndieAuthController.php b/app/Http/Controllers/IndieAuthController.php deleted file mode 100644 index 45b488da..00000000 --- a/app/Http/Controllers/IndieAuthController.php +++ /dev/null @@ -1,327 +0,0 @@ -json([ - 'issuer' => config('app.url'), - 'authorization_endpoint' => route('indieauth.start'), - 'token_endpoint' => route('indieauth.token'), - 'code_challenge_methods_supported' => ['S256'], - // 'introspection_endpoint' => route('indieauth.introspection'), - // 'introspection_endpoint_auth_methods_supported' => ['none'], - ]); - } - - /** - * Process a GET request to the IndieAuth endpoint. - * - * This is the first step in the IndieAuth flow, where the client app sends the user to the IndieAuth endpoint. - */ - public function start(Request $request): View - { - // First check all required params are present - $validator = Validator::make($request->all(), [ - 'response_type' => 'required:string', - 'client_id' => 'required', - 'redirect_uri' => 'required', - 'state' => 'required', - 'code_challenge' => 'required:string', - 'code_challenge_method' => 'required:string', - ], [ - 'response_type' => 'response_type is required', - 'client_id.required' => 'client_id is required to display which app is asking for authentication', - 'redirect_uri.required' => 'redirect_uri is required so we can progress successful requests', - 'state.required' => 'state is required', - 'code_challenge.required' => 'code_challenge is required', - 'code_challenge_method.required' => 'code_challenge_method is required', - ]); - - if ($validator->fails()) { - return view('indieauth.error')->withErrors($validator); - } - - if ($request->get('response_type') !== 'code') { - return view('indieauth.error')->withErrors(['response_type' => 'only a response_type of "code" is supported']); - } - - if (mb_strtoupper($request->get('code_challenge_method')) !== 'S256') { - return view('indieauth.error')->withErrors(['code_challenge_method' => 'only a code_challenge_method of "S256" is supported']); - } - - if (! $this->isValidRedirectUri($request->get('client_id'), $request->get('redirect_uri'))) { - return view('indieauth.error')->withErrors(['redirect_uri' => 'redirect_uri is not valid for this client_id']); - } - - $scopes = $request->get('scope', ''); - $scopes = explode(' ', $scopes); - - return view('indieauth.start', [ - 'me' => $request->get('me'), - 'client_id' => $request->get('client_id'), - 'redirect_uri' => $request->get('redirect_uri'), - 'state' => $request->get('state'), - 'scopes' => $scopes, - 'code_challenge' => $request->get('code_challenge'), - 'code_challenge_method' => $request->get('code_challenge_method'), - ]); - } - - /** - * Confirm an IndieAuth approval request. - * - * Generates an auth code and redirects the user back to the client app. - * - * @throws RandomException - */ - public function confirm(Request $request): RedirectResponse - { - $authCode = bin2hex(random_bytes(16)); - - $cacheKey = hash('xxh3', $request->get('client_id')); - - $indieAuthRequestData = [ - 'code_challenge' => $request->get('code_challenge'), - 'code_challenge_method' => $request->get('code_challenge_method'), - 'client_id' => $request->get('client_id'), - 'redirect_uri' => $request->get('redirect_uri'), - 'auth_code' => $authCode, - 'scope' => implode(' ', $request->get('scope', '')), - ]; - - Cache::put($cacheKey, $indieAuthRequestData, now()->addMinutes(10)); - - $redirectUri = new Uri($request->get('redirect_uri')); - $redirectUri = Uri::withQueryValues($redirectUri, [ - 'code' => $authCode, - 'state' => $request->get('state'), - 'iss' => config('app.url'), - ]); - - return redirect()->away($redirectUri); - } - - /** - * Process a POST request to the IndieAuth auth endpoint. - * - * This is one possible second step in the IndieAuth flow, where the client app sends the auth code to the IndieAuth - * endpoint. As it is to the auth endpoint we return profile information. A similar request can be made to the token - * endpoint to get an access token. - */ - public function processCodeExchange(Request $request): JsonResponse - { - $invalidCodeResponse = $this->validateAuthorizationCode($request); - - if ($invalidCodeResponse instanceof JsonResponse) { - return $invalidCodeResponse; - } - - return response()->json([ - 'me' => config('app.url'), - ]); - } - - /** - * Process a POST request to the IndieAuth token endpoint. - * - * This is another possible second step in the IndieAuth flow, where the client app sends the auth code to the - * IndieAuth token endpoint. As it is to the token endpoint we return an access token. - * - * @throws SodiumException - */ - public function processTokenRequest(Request $request): JsonResponse - { - $indieAuthData = $this->validateAuthorizationCode($request); - - if ($indieAuthData instanceof JsonResponse) { - return $indieAuthData; - } - - if ($indieAuthData['scope'] === '') { - return response()->json(['errors' => [ - 'scope' => [ - 'The scope property must be non-empty for an access token to be issued.', - ], - ]], 400); - } - - $tokenData = [ - 'me' => config('app.url'), - 'client_id' => $request->get('client_id'), - 'scope' => $indieAuthData['scope'], - ]; - $tokenService = resolve(TokenService::class); - $token = $tokenService->getNewToken($tokenData); - - return response()->json([ - 'access_token' => $token, - 'token_type' => 'Bearer', - 'scope' => $indieAuthData['scope'], - 'me' => config('app.url'), - ]); - } - - protected function isValidRedirectUri(string $clientId, string $redirectUri): bool - { - // If client_id is not a valid URL, then it's not valid - $clientIdParsed = \Mf2\parseUriToComponents($clientId); - if (! isset($clientIdParsed['authority'])) { - return false; - } - - // If redirect_uri is not a valid URL, then it's not valid - $redirectUriParsed = \Mf2\parseUriToComponents($redirectUri); - if (! isset($redirectUriParsed['authority'])) { - return false; - } - - // If client_id and redirect_uri are the same host, then it's valid - if ($clientIdParsed['authority'] === $redirectUriParsed['authority']) { - return true; - } - - // Otherwise we need to check the redirect_uri is in the client_id's redirect_uris - $guzzle = resolve(Client::class); - - try { - $clientInfo = $guzzle->get($clientId); - } catch (Exception) { - return false; - } - - $clientInfoParsed = \Mf2\parse($clientInfo->getBody()->getContents(), $clientId); - - $redirectUris = $clientInfoParsed['rels']['redirect_uri'] ?? []; - - return in_array($redirectUri, $redirectUris, true); - } - - /** - * @throws SodiumException - */ - protected function validateAuthorizationCode(Request $request): JsonResponse|array - { - // First check all the data is present - $validator = Validator::make($request->all(), [ - 'grant_type' => 'required:string', - 'code' => 'required:string', - 'client_id' => 'required', - 'redirect_uri' => 'required', - 'code_verifier' => 'required', - ]); - - if ($validator->fails()) { - return response()->json(['errors' => $validator->errors()], 400); - } - - if ($request->get('grant_type') !== 'authorization_code') { - return response()->json(['errors' => [ - 'grant_type' => [ - 'Only a grant type of "authorization_code" is supported.', - ], - ]], 400); - } - - // Check cache for auth code - $cacheKey = hash('xxh3', $request->get('client_id')); - $indieAuthRequestData = Cache::pull($cacheKey); - - if ($indieAuthRequestData === null) { - return response()->json(['errors' => [ - 'code' => [ - 'The code is invalid.', - ], - ]], 404); - } - - // Check the IndieAuth code - if (! array_key_exists('auth_code', $indieAuthRequestData)) { - return response()->json(['errors' => [ - 'code' => [ - 'The code is invalid.', - ], - ]], 400); - } - if ($indieAuthRequestData['auth_code'] !== $request->get('code')) { - return response()->json(['errors' => [ - 'code' => [ - 'The code is invalid.', - ], - ]], 400); - } - - // Check code verifier - if (! array_key_exists('code_challenge', $indieAuthRequestData)) { - return response()->json(['errors' => [ - 'code_verifier' => [ - 'The code verifier is invalid.', - ], - ]], 400); - } - if (! hash_equals( - $indieAuthRequestData['code_challenge'], - sodium_bin2base64( - hash('sha256', $request->get('code_verifier'), true), - SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING - ) - )) { - return response()->json(['errors' => [ - 'code_verifier' => [ - 'The code verifier is invalid.', - ], - ]], 400); - } - - // Check redirect_uri - if (! array_key_exists('redirect_uri', $indieAuthRequestData)) { - return response()->json(['errors' => [ - 'redirect_uri' => [ - 'The redirect uri is invalid.', - ], - ]], 400); - } - if ($indieAuthRequestData['redirect_uri'] !== $request->get('redirect_uri')) { - return response()->json(['errors' => [ - 'redirect_uri' => [ - 'The redirect uri is invalid.', - ], - ]], 400); - } - - // Check client_id - if (! array_key_exists('client_id', $indieAuthRequestData)) { - return response()->json(['errors' => [ - 'client_id' => [ - 'The client id is invalid.', - ], - ]], 400); - } - if ($indieAuthRequestData['client_id'] !== $request->get('client_id')) { - return response()->json(['errors' => [ - 'client_id' => [ - 'The client id is invalid.', - ], - ]], 400); - } - - return $indieAuthRequestData; - } -} diff --git a/app/Http/Controllers/LikesController.php b/app/Http/Controllers/LikesController.php index af1c483c..48c5ffd7 100644 --- a/app/Http/Controllers/LikesController.php +++ b/app/Http/Controllers/LikesController.php @@ -11,6 +11,8 @@ class LikesController extends Controller { /** * Show the latest likes. + * + * @return View */ public function index(): View { @@ -21,6 +23,9 @@ class LikesController extends Controller /** * Show a single like. + * + * @param Like $like + * @return View */ public function show(Like $like): View { diff --git a/app/Http/Controllers/MicropubController.php b/app/Http/Controllers/MicropubController.php index 758b3255..b540ca18 100644 --- a/app/Http/Controllers/MicropubController.php +++ b/app/Http/Controllers/MicropubController.php @@ -4,73 +4,110 @@ declare(strict_types=1); namespace App\Http\Controllers; -use App\Exceptions\InvalidTokenScopeException; -use App\Exceptions\MicropubHandlerException; -use App\Http\Requests\MicropubRequest; +use App\Http\Responses\MicropubResponses; use App\Models\Place; use App\Models\SyndicationTarget; -use App\Services\Micropub\MicropubHandlerRegistry; +use App\Services\Micropub\HCardService; +use App\Services\Micropub\HEntryService; +use App\Services\Micropub\UpdateService; +use App\Services\TokenService; use Illuminate\Http\JsonResponse; use Illuminate\Http\Request; -use Lcobucci\JWT\Token; +use Lcobucci\JWT\Encoding\CannotDecodeContent; +use Lcobucci\JWT\Token\InvalidTokenStructure; +use Lcobucci\JWT\Validation\RequiredConstraintsViolated; +use Monolog\Handler\StreamHandler; +use Monolog\Logger; class MicropubController extends Controller { - protected MicropubHandlerRegistry $handlerRegistry; + protected TokenService $tokenService; - public function __construct(MicropubHandlerRegistry $handlerRegistry) - { - $this->handlerRegistry = $handlerRegistry; + protected HEntryService $hentryService; + + protected HCardService $hcardService; + + protected UpdateService $updateService; + + public function __construct( + TokenService $tokenService, + HEntryService $hentryService, + HCardService $hcardService, + UpdateService $updateService + ) { + $this->tokenService = $tokenService; + $this->hentryService = $hentryService; + $this->hcardService = $hcardService; + $this->updateService = $updateService; } /** - * Respond to a POST request to the micropub endpoint. + * This function receives an API request, verifies the authenticity + * then passes over the info to the relevant Service class. * - * The request is initially processed by the MicropubRequest form request - * class. The normalizes the data, so we can pass it into the handlers for - * the different micropub requests, h-entry or h-card, for example. + * @param Request $request + * @return JsonResponse */ - public function post(MicropubRequest $request): JsonResponse + public function post(Request $request): JsonResponse { - $type = $request->getType(); - - if (! $type) { - return response()->json([ - 'error' => 'invalid_request', - 'error_description' => 'Microformat object type is missing, for example: h-entry or h-card', - ], 400); - } - try { - $handler = $this->handlerRegistry->getHandler($type); - $result = $handler->handle($request->getMicropubData()); + $tokenData = $this->tokenService->validateToken($request->input('access_token')); + } catch (RequiredConstraintsViolated | InvalidTokenStructure | CannotDecodeContent) { + $micropubResponses = new MicropubResponses(); - // Return appropriate response based on the handler result - return response()->json([ - 'response' => $result['response'], - 'location' => $result['url'] ?? null, - ], 201)->header('Location', $result['url']); - } catch (\InvalidArgumentException $e) { - return response()->json([ - 'error' => 'invalid_request', - 'error_description' => $e->getMessage(), - ], 400); - } catch (MicropubHandlerException) { - return response()->json([ - 'error' => 'Unknown Micropub type', - 'error_description' => 'The request could not be processed by this server', - ], 500); - } catch (InvalidTokenScopeException) { - return response()->json([ - 'error' => 'invalid_scope', - 'error_description' => 'The token does not have the required scope for this request', - ], 403); - } catch (\Exception) { - return response()->json([ - 'error' => 'server_error', - 'error_description' => 'An error occurred processing the request', - ], 500); + return $micropubResponses->invalidTokenResponse(); } + + if ($tokenData->claims()->has('scope') === false) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->tokenHasNoScopeResponse(); + } + + $this->logMicropubRequest($request->all()); + + if (($request->input('h') === 'entry') || ($request->input('type.0') === 'h-entry')) { + if (stripos($tokenData->claims()->get('scope'), 'create') === false) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->insufficientScopeResponse(); + } + $location = $this->hentryService->process($request->all(), $this->getCLientId()); + + return response()->json([ + 'response' => 'created', + 'location' => $location, + ], 201)->header('Location', $location); + } + + if ($request->input('h') === 'card' || $request->input('type.0') === 'h-card') { + if (stripos($tokenData->claims()->get('scope'), 'create') === false) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->insufficientScopeResponse(); + } + $location = $this->hcardService->process($request->all()); + + return response()->json([ + 'response' => 'created', + 'location' => $location, + ], 201)->header('Location', $location); + } + + if ($request->input('action') === 'update') { + if (stripos($tokenData->claims()->get('scope'), 'update') === false) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->insufficientScopeResponse(); + } + + return $this->updateService->process($request->all()); + } + + return response()->json([ + 'response' => 'error', + 'error_description' => 'unsupported_request_type', + ], 500); } /** @@ -80,29 +117,37 @@ class MicropubController extends Controller * token, here we check whether the token is valid and respond * appropriately. Further if the request has the query parameter * syndicate-to we respond with the known syndication endpoints. + * + * @return JsonResponse */ - public function get(Request $request): JsonResponse + public function get(): JsonResponse { - if ($request->input('q') === 'syndicate-to') { + try { + $tokenData = $this->tokenService->validateToken(request()->input('access_token')); + } catch (RequiredConstraintsViolated | InvalidTokenStructure) { + return (new MicropubResponses())->invalidTokenResponse(); + } + + if (request()->input('q') === 'syndicate-to') { return response()->json([ 'syndicate-to' => SyndicationTarget::all(), ]); } - if ($request->input('q') === 'config') { + if (request()->input('q') === 'config') { return response()->json([ 'syndicate-to' => SyndicationTarget::all(), 'media-endpoint' => route('media-endpoint'), ]); } - if ($request->has('q') && str_starts_with($request->input('q'), 'geo:')) { + if (request()->has('q') && substr(request()->input('q'), 0, 4) === 'geo:') { preg_match_all( '/([0-9.\-]+)/', - $request->input('q'), + request()->input('q'), $matches ); - $distance = (count($matches[0]) === 3) ? 100 * $matches[0][2] : 1000; + $distance = (count($matches[0]) == 3) ? 100 * $matches[0][2] : 1000; $places = Place::near( (object) ['latitude' => $matches[0][0], 'longitude' => $matches[0][1]], $distance @@ -114,17 +159,40 @@ class MicropubController extends Controller ]); } - // the default response is just to return the token data - /** @var Token $tokenData */ - $tokenData = $request->input('token_data'); - + // default response is just to return the token data return response()->json([ 'response' => 'token', 'token' => [ - 'me' => $tokenData['me'], - 'scope' => $tokenData['scope'], - 'client_id' => $tokenData['client_id'], + 'me' => $tokenData->claims()->get('me'), + 'scope' => $tokenData->claims()->get('scope'), + 'client_id' => $tokenData->claims()->get('client_id'), ], ]); } + + /** + * Determine the client id from the access token sent with the request. + * + * @return string + * + * @throws RequiredConstraintsViolated + */ + private function getClientId(): string + { + return resolve(TokenService::class) + ->validateToken(request()->input('access_token')) + ->claims()->get('client_id'); + } + + /** + * Save the details of the micropub request to a log file. + * + * @param array $request This is the info from request()->all() + */ + private function logMicropubRequest(array $request) + { + $logger = new Logger('micropub'); + $logger->pushHandler(new StreamHandler(storage_path('logs/micropub.log'))); + $logger->debug('MicropubLog', $request); + } } diff --git a/app/Http/Controllers/MicropubMediaController.php b/app/Http/Controllers/MicropubMediaController.php index fc804ea2..52cc252d 100644 --- a/app/Http/Controllers/MicropubMediaController.php +++ b/app/Http/Controllers/MicropubMediaController.php @@ -7,64 +7,85 @@ namespace App\Http\Controllers; use App\Http\Responses\MicropubResponses; use App\Jobs\ProcessMedia; use App\Models\Media; +use App\Services\TokenService; use Exception; use Illuminate\Contracts\Container\BindingResolutionException; +use Illuminate\Database\Eloquent\ModelNotFoundException; +use Illuminate\Http\File; use Illuminate\Http\JsonResponse; -use Illuminate\Http\Request; use Illuminate\Http\Response; use Illuminate\Http\UploadedFile; use Illuminate\Support\Carbon; use Illuminate\Support\Facades\Storage; +use Illuminate\Support\Str; +use Intervention\Image\Exception\NotReadableException; use Intervention\Image\ImageManager; +use Lcobucci\JWT\Token\InvalidTokenStructure; +use Lcobucci\JWT\Validation\RequiredConstraintsViolated; use Ramsey\Uuid\Uuid; class MicropubMediaController extends Controller { - public function getHandler(Request $request): JsonResponse + protected TokenService $tokenService; + + public function __construct(TokenService $tokenService) { - $tokenData = $request->input('token_data'); + $this->tokenService = $tokenService; + } - $scopes = $tokenData['scope']; - if (is_string($scopes)) { - $scopes = explode(' ', $scopes); - } - if (! in_array('create', $scopes, true)) { - return (new MicropubResponses)->insufficientScopeResponse(); + public function getHandler(): JsonResponse + { + try { + $tokenData = $this->tokenService->validateToken(request()->input('access_token')); + } catch (RequiredConstraintsViolated | InvalidTokenStructure $exception) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->invalidTokenResponse(); } - if ($request->input('q') === 'last') { - $media = Media::where('created_at', '>=', Carbon::now()->subMinutes(30)) - ->where('token', $request->input('access_token')) - ->latest() - ->first(); - $mediaUrl = $media?->url; + if ($tokenData->claims()->has('scope') === false) { + $micropubResponses = new MicropubResponses(); - return response()->json(['url' => $mediaUrl]); + return $micropubResponses->tokenHasNoScopeResponse(); } - if ($request->input('q') === 'source') { - $limit = $request->input('limit', 10); - $offset = $request->input('offset', 0); + if (Str::contains($tokenData->claims()->get('scope'), 'create') === false) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->insufficientScopeResponse(); + } + + if (request()->input('q') === 'last') { + try { + $media = Media::latest()->whereDate('created_at', '>=', Carbon::now()->subMinutes(30))->firstOrFail(); + } catch (ModelNotFoundException $exception) { + return response()->json(['url' => null]); + } + + return response()->json(['url' => $media->url]); + } + + if (request()->input('q') === 'source') { + $limit = request()->input('limit', 10); + $offset = request()->input('offset', 0); $media = Media::latest()->offset($offset)->limit($limit)->get(); $media->transform(function ($mediaItem) { return [ 'url' => $mediaItem->url, - 'published' => $mediaItem->created_at->toW3cString(), - 'mime_type' => $mediaItem->mimetype, ]; }); return response()->json(['items' => $media]); } - if ($request->has('q')) { + if (request()->has('q')) { return response()->json([ 'error' => 'invalid_request', 'error_description' => sprintf( 'This server does not know how to handle this q parameter (%s)', - $request->input('q') + request()->input('q') ), ], 400); } @@ -75,22 +96,34 @@ class MicropubMediaController extends Controller /** * Process a media item posted to the media endpoint. * + * @return JsonResponse + * * @throws BindingResolutionException * @throws Exception */ - public function media(Request $request): JsonResponse + public function media(): JsonResponse { - $tokenData = $request->input('token_data'); + try { + $tokenData = $this->tokenService->validateToken(request()->input('access_token')); + } catch (RequiredConstraintsViolated | InvalidTokenStructure $exception) { + $micropubResponses = new MicropubResponses(); - $scopes = $tokenData['scope']; - if (is_string($scopes)) { - $scopes = explode(' ', $scopes); - } - if (! in_array('create', $scopes, true)) { - return (new MicropubResponses)->insufficientScopeResponse(); + return $micropubResponses->invalidTokenResponse(); } - if ($request->hasFile('file') === false) { + if ($tokenData->claims()->has('scope') === false) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->tokenHasNoScopeResponse(); + } + + if (Str::contains($tokenData->claims()->get('scope'), 'create') === false) { + $micropubResponses = new MicropubResponses(); + + return $micropubResponses->insufficientScopeResponse(); + } + + if (request()->hasFile('file') === false) { return response()->json([ 'response' => 'error', 'error' => 'invalid_request', @@ -98,10 +131,7 @@ class MicropubMediaController extends Controller ], 400); } - /** @var UploadedFile $file */ - $file = $request->file('file'); - - if ($file->isValid() === false) { + if (request()->file('file')->isValid() === false) { return response()->json([ 'response' => 'error', 'error' => 'invalid_request', @@ -109,25 +139,31 @@ class MicropubMediaController extends Controller ], 400); } - $filename = Storage::disk('local')->putFile('media', $file); + $filename = $this->saveFile(request()->file('file')); - /** @var ImageManager $manager */ $manager = resolve(ImageManager::class); try { - $image = $manager->read($request->file('file')); + $image = $manager->make(request()->file('file')); $width = $image->width(); - } catch (Exception) { + } catch (NotReadableException $exception) { // not an image $width = null; } $media = Media::create([ - 'token' => $request->input('access_token'), - 'path' => $filename, - 'type' => $this->getFileTypeFromMimeType($request->file('file')->getMimeType()), + 'token' => request()->bearerToken(), + 'path' => 'media/' . $filename, + 'type' => $this->getFileTypeFromMimeType(request()->file('file')->getMimeType()), 'image_widths' => $width, ]); + // put the file on S3 initially, the ProcessMedia job may edit this + Storage::disk('s3')->putFileAs( + 'media', + new File(storage_path('app') . '/' . $filename), + $filename + ); + ProcessMedia::dispatch($filename); return response()->json([ @@ -138,6 +174,8 @@ class MicropubMediaController extends Controller /** * Return the relevant CORS headers to a pre-flight OPTIONS request. + * + * @return Response */ public function mediaOptionsResponse(): Response { @@ -146,10 +184,13 @@ class MicropubMediaController extends Controller /** * Get the file type from the mime-type of the uploaded file. + * + * @param string $mimeType + * @return string */ private function getFileTypeFromMimeType(string $mimeType): string { - // try known images + //try known images $imageMimeTypes = [ 'image/gif', 'image/jpeg', @@ -161,7 +202,7 @@ class MicropubMediaController extends Controller if (in_array($mimeType, $imageMimeTypes)) { return 'image'; } - // try known video + //try known video $videoMimeTypes = [ 'video/mp4', 'video/mpeg', @@ -172,7 +213,7 @@ class MicropubMediaController extends Controller if (in_array($mimeType, $videoMimeTypes)) { return 'video'; } - // try known audio types + //try known audio types $audioMimeTypes = [ 'audio/midi', 'audio/mpeg', @@ -189,9 +230,12 @@ class MicropubMediaController extends Controller /** * Save an uploaded file to the local disk. * + * @param UploadedFile $file + * @return string + * * @throws Exception */ - private function saveFileToLocal(UploadedFile $file): string + private function saveFile(UploadedFile $file): string { $filename = Uuid::uuid4()->toString() . '.' . $file->extension(); Storage::disk('local')->putFileAs('', $file, $filename); diff --git a/app/Http/Controllers/NotesController.php b/app/Http/Controllers/NotesController.php index d5c9bc90..56768747 100644 --- a/app/Http/Controllers/NotesController.php +++ b/app/Http/Controllers/NotesController.php @@ -5,6 +5,7 @@ declare(strict_types=1); namespace App\Http\Controllers; use App\Models\Note; +use App\Services\ActivityStreamsService; use Illuminate\Database\Eloquent\ModelNotFoundException; use Illuminate\Http\JsonResponse; use Illuminate\Http\RedirectResponse; @@ -12,26 +13,25 @@ use Illuminate\Http\Response; use Illuminate\View\View; use Jonnybarnes\IndieWeb\Numbers; -/** - * @todo Need to sort out Twitter and webmentions! - */ +// Need to sort out Twitter and webmentions! + class NotesController extends Controller { /** * Show all the notes. This is also the homepage. + * + * @return View|Response */ - public function index(): View|Response + public function index() { + if (request()->wantsActivityStream()) { + return (new ActivityStreamsService())->siteOwnerResponse(); + } + $notes = Note::latest() ->with('place', 'media', 'client') - ->withCount(['webmentions AS replies' => function ($query) { + ->withCount(['webmentions As replies' => function ($query) { $query->where('type', 'in-reply-to'); - }]) - ->withCount(['webmentions AS likes' => function ($query) { - $query->where('type', 'like-of'); - }]) - ->withCount(['webmentions AS reposts' => function ($query) { - $query->where('type', 'repost-of'); }])->paginate(10); return view('notes.index', compact('notes')); @@ -39,37 +39,41 @@ class NotesController extends Controller /** * Show a single note. + * + * @param string $urlId The id of the note + * @return View|JsonResponse|Response */ - public function show(string $urlId): View|JsonResponse|Response + public function show(string $urlId) { try { - $note = Note::nb60($urlId)->with('place', 'media', 'client') - ->withCount(['webmentions AS replies' => function ($query) { - $query->where('type', 'in-reply-to'); - }]) - ->withCount(['webmentions AS likes' => function ($query) { - $query->where('type', 'like-of'); - }]) - ->withCount(['webmentions AS reposts' => function ($query) { - $query->where('type', 'repost-of'); - }])->firstOrFail(); + $note = Note::nb60($urlId)->with('webmentions')->firstOrFail(); } catch (ModelNotFoundException $exception) { abort(404); } + if (request()->wantsActivityStream()) { + return (new ActivityStreamsService())->singleNoteResponse($note); + } + return view('notes.show', compact('note')); } /** * Redirect /note/{decID} to /notes/{nb60id}. + * + * @param int $decId The decimal id of the note + * @return RedirectResponse */ public function redirect(int $decId): RedirectResponse { - return redirect(config('app.url') . '/notes/' . (new Numbers)->numto60($decId)); + return redirect(config('app.url') . '/notes/' . (new Numbers())->numto60($decId)); } /** * Show all notes tagged with {tag}. + * + * @param string $tag + * @return View */ public function tagged(string $tag): View { @@ -84,6 +88,8 @@ class NotesController extends Controller * Page to create a new note. * * Dummy page for now. + * + * @return View */ public function create(): View { diff --git a/app/Http/Controllers/PlacesController.php b/app/Http/Controllers/PlacesController.php index b949ecde..fb66574f 100644 --- a/app/Http/Controllers/PlacesController.php +++ b/app/Http/Controllers/PlacesController.php @@ -11,6 +11,8 @@ class PlacesController extends Controller { /** * Show all the places. + * + * @return View */ public function index(): View { @@ -21,6 +23,9 @@ class PlacesController extends Controller /** * Show a specific place. + * + * @param Place $place + * @return View */ public function show(Place $place): View { diff --git a/app/Http/Controllers/SearchController.php b/app/Http/Controllers/SearchController.php deleted file mode 100644 index 3f366538..00000000 --- a/app/Http/Controllers/SearchController.php +++ /dev/null @@ -1,34 +0,0 @@ -input('q'); - - $notes = Note::search($search) - ->paginate(); - - /** @var Note $note */ - foreach ($notes as $note) { - $note->load('place', 'media', 'client') - ->loadCount(['webmentions AS replies' => function ($query) { - $query->where('type', 'in-reply-to'); - }]) - ->loadCount(['webmentions AS likes' => function ($query) { - $query->where('type', 'like-of'); - }]) - ->loadCount(['webmentions AS reposts' => function ($query) { - $query->where('type', 'repost-of'); - }]); - } - - return view('search', compact('search', 'notes')); - } -} diff --git a/app/Http/Controllers/ShortURLsController.php b/app/Http/Controllers/ShortURLsController.php new file mode 100644 index 00000000..e93f51ac --- /dev/null +++ b/app/Http/Controllers/ShortURLsController.php @@ -0,0 +1,59 @@ +client = $client; + $this->guzzle = $guzzle; + $this->tokenService = $tokenService; + } + + /** + * If the user has authā€™d via the IndieAuth protocol, issue a valid token. + * + * @param Request $request + * @return JsonResponse + */ + public function create(Request $request): JsonResponse + { + $auth = $this->verifyIndieAuthCode( + config('app.authorization_endpoint'), + $request->input('code'), + $request->input('redirect_uri'), + $request->input('client_id'), + ); + + if ($auth === null || ! array_key_exists('me', $auth)) { + return response()->json([ + 'error' => 'There was an error verifying the IndieAuth code', + ], 401); + } + + $scope = $auth['scope'] ?? ''; + $tokenData = [ + 'me' => config('app.url'), + 'client_id' => $request->input('client_id'), + 'scope' => $scope, + ]; + $token = $this->tokenService->getNewToken($tokenData); + $content = [ + 'me' => config('app.url'), + 'scope' => $scope, + 'access_token' => $token, + ]; + + return response()->json($content); + } + + protected function verifyIndieAuthCode( + string $authorizationEndpoint, + string $code, + string $redirectUri, + string $clientId + ): ?array { + try { + $response = $this->guzzle->request('POST', $authorizationEndpoint, [ + 'headers' => [ + 'Accept' => 'application/json', + ], + 'form_params' => [ + 'code' => $code, + 'me' => config('app.url'), + 'redirect_uri' => $redirectUri, + 'client_id' => $clientId, + ], + ]); + } catch (BadResponseException) { + return null; + } + + try { + $authData = json_decode((string) $response->getBody(), true, 512, JSON_THROW_ON_ERROR); + } catch (JsonException) { + return null; + } + + return $authData; + } +} diff --git a/app/Http/Controllers/WebMentionsController.php b/app/Http/Controllers/WebMentionsController.php index 49eac9b2..2b2905db 100644 --- a/app/Http/Controllers/WebMentionsController.php +++ b/app/Http/Controllers/WebMentionsController.php @@ -7,7 +7,6 @@ namespace App\Http\Controllers; use App\Jobs\ProcessWebMention; use App\Models\Note; use Illuminate\Database\Eloquent\ModelNotFoundException; -use Illuminate\Http\Request; use Illuminate\Http\Response; use Illuminate\View\View; use Jonnybarnes\IndieWeb\Numbers; @@ -19,6 +18,8 @@ class WebMentionsController extends Controller * * This is probably someone looking for information about what * webmentions are, or about my particular implementation. + * + * @return View */ public function get(): View { @@ -27,27 +28,29 @@ class WebMentionsController extends Controller /** * Receive and process a webmention. + * + * @return Response */ - public function receive(Request $request): Response + public function receive(): Response { - // first we trivially reject requests that lack all required inputs - if (($request->has('target') !== true) || ($request->has('source') !== true)) { + //first we trivially reject requests that lack all required inputs + if ((request()->has('target') !== true) || (request()->has('source') !== true)) { return response( 'You need both the target and source parameters', 400 ); } - // next check the $target is valid - $path = parse_url($request->input('target'), PHP_URL_PATH); + //next check the $target is valid + $path = parse_url(request()->input('target'), PHP_URL_PATH); $pathParts = explode('/', $path); - if ($pathParts[1] === 'notes') { - // we have a note + if ($pathParts[1] == 'notes') { + //we have a note $noteId = $pathParts[2]; try { $note = Note::findOrFail(resolve(Numbers::class)->b60tonum($noteId)); - dispatch(new ProcessWebMention($note, $request->input('source'))); + dispatch(new ProcessWebMention($note, request()->input('source'))); } catch (ModelNotFoundException $e) { return response('This note doesnā€™t exist.', 400); } @@ -57,7 +60,7 @@ class WebMentionsController extends Controller 202 ); } - if ($pathParts[1] === 'blog') { + if ($pathParts[1] == 'blog') { return response( 'I donā€™t accept webmentions for blog posts yet.', 501 diff --git a/app/Http/Kernel.php b/app/Http/Kernel.php new file mode 100644 index 00000000..5da917fc --- /dev/null +++ b/app/Http/Kernel.php @@ -0,0 +1,73 @@ + [ + \App\Http\Middleware\EncryptCookies::class, + \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class, + \Illuminate\Session\Middleware\StartSession::class, + // \Illuminate\Session\Middleware\AuthenticateSession::class, + \Illuminate\View\Middleware\ShareErrorsFromSession::class, + \App\Http\Middleware\VerifyCsrfToken::class, + \Illuminate\Routing\Middleware\SubstituteBindings::class, + \App\Http\Middleware\LinkHeadersMiddleware::class, + \App\Http\Middleware\LocalhostSessionMiddleware::class, + \App\Http\Middleware\ActivityStreamLinks::class, + \App\Http\Middleware\CSPHeader::class, + ], + + 'api' => [ + 'throttle:api', + \Illuminate\Routing\Middleware\SubstituteBindings::class, + ], + ]; + + /** + * The application's route middleware. + * + * These middleware may be assigned to groups or used individually. + * + * @var array + */ + protected $routeMiddleware = [ + 'auth' => \App\Http\Middleware\Authenticate::class, + 'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class, + 'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class, + 'can' => \Illuminate\Auth\Middleware\Authorize::class, + 'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class, + 'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class, + 'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class, + 'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class, + 'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class, + 'micropub.token' => \App\Http\Middleware\VerifyMicropubToken::class, + 'myauth' => \App\Http\Middleware\MyAuthMiddleware::class, + 'cors' => \App\Http\Middleware\CorsHeaders::class, + ]; +} diff --git a/app/Http/Middleware/ActivityStreamLinks.php b/app/Http/Middleware/ActivityStreamLinks.php new file mode 100644 index 00000000..4cad411f --- /dev/null +++ b/app/Http/Middleware/ActivityStreamLinks.php @@ -0,0 +1,31 @@ +path() === '/') { + $response->header('Link', '<' . config('app.url') . '>; rel="application/activity+json"', false); + } + if ($request->is('notes/*')) { + $response->header('Link', '<' . $request->url() . '>; rel="application/activity+json"', false); + } + + return $response; + } +} diff --git a/app/Http/Middleware/Authenticate.php b/app/Http/Middleware/Authenticate.php index 624cd371..81e6fd40 100644 --- a/app/Http/Middleware/Authenticate.php +++ b/app/Http/Middleware/Authenticate.php @@ -3,7 +3,6 @@ namespace App\Http\Middleware; use Illuminate\Auth\Middleware\Authenticate as Middleware; -use Illuminate\Http\Request; /** * @codeCoverageIgnore @@ -12,9 +11,14 @@ class Authenticate extends Middleware { /** * Get the path the user should be redirected to when they are not authenticated. + * + * @param \Illuminate\Http\Request $request + * @return string */ - protected function redirectTo(Request $request): ?string + protected function redirectTo($request) { - return $request->expectsJson() ? null : route('login'); + if (! $request->expectsJson()) { + return route('login'); + } } } diff --git a/app/Http/Middleware/CSPHeader.php b/app/Http/Middleware/CSPHeader.php new file mode 100644 index 00000000..bf2202ed --- /dev/null +++ b/app/Http/Middleware/CSPHeader.php @@ -0,0 +1,49 @@ +header( + 'Content-Security-Policy', + "default-src 'self'; " . + "style-src 'self' cloud.typography.com jonnybarnes.uk; " . + "img-src 'self' data: blob: https://pbs.twimg.com https://jbuk-media.s3-eu-west-1.amazonaws.com https://jbuk-media-dev.s3-eu-west-1.amazonaws.com https://secure.gravatar.com https://graph.facebook.com *.fbcdn.net https://*.cdninstagram.com https://*.4sqi.net https://upload.wikimedia.org; " . + "font-src 'self' data:; " . + "frame-src 'self' https://www.youtube.com blob:; " . + 'upgrade-insecure-requests; ' . + 'block-all-mixed-content; ' . + 'report-to csp-endpoint; ' . + 'report-uri https://jonnybarnes.report-uri.io/r/default/csp/enforce;' + )->header( + 'Report-To', + '{' . + "'url': 'https://jonnybarnes.report-uri.io/r/default/csp/enforce', " . + "'group': 'csp-endpoint', " . + "'max-age': 10886400" . + '}' + ); + // phpcs:enable Generic.Files.LineLength.TooLong + } +} diff --git a/app/Http/Middleware/CheckForMaintenanceMode.php b/app/Http/Middleware/CheckForMaintenanceMode.php new file mode 100644 index 00000000..35b9824b --- /dev/null +++ b/app/Http/Middleware/CheckForMaintenanceMode.php @@ -0,0 +1,17 @@ +path() === 'api/media') { diff --git a/app/Http/Middleware/EncryptCookies.php b/app/Http/Middleware/EncryptCookies.php index 867695bd..033136ad 100644 --- a/app/Http/Middleware/EncryptCookies.php +++ b/app/Http/Middleware/EncryptCookies.php @@ -9,7 +9,7 @@ class EncryptCookies extends Middleware /** * The names of the cookies that should not be encrypted. * - * @var array + * @var array */ protected $except = [ // diff --git a/app/Http/Middleware/LinkHeadersMiddleware.php b/app/Http/Middleware/LinkHeadersMiddleware.php index 467283db..66dee526 100644 --- a/app/Http/Middleware/LinkHeadersMiddleware.php +++ b/app/Http/Middleware/LinkHeadersMiddleware.php @@ -3,22 +3,23 @@ namespace App\Http\Middleware; use Closure; -use Illuminate\Http\Request; -use Symfony\Component\HttpFoundation\Response; class LinkHeadersMiddleware { /** * Handle an incoming request. + * + * @param \Illuminate\Http\Request $request + * @param \Closure $next + * @return mixed */ - public function handle(Request $request, Closure $next): Response + public function handle($request, Closure $next) { $response = $next($request); - $response->header('Link', '<' . route('indieauth.metadata') . '>; rel="indieauth-metadata"', false); - $response->header('Link', '<' . route('indieauth.start') . '>; rel="authorization_endpoint"', false); - $response->header('Link', '<' . route('indieauth.token') . '>; rel="token_endpoint"', false); - $response->header('Link', '<' . route('micropub-endpoint') . '>; rel="micropub"', false); - $response->header('Link', '<' . route('webmention-endpoint') . '>; rel="webmention"', false); + $response->header('Link', '; rel="authorization_endpoint"', false); + $response->header('Link', '<' . config('app.url') . '/api/token>; rel="token_endpoint"', false); + $response->header('Link', '<' . config('app.url') . '/api/post>; rel="micropub"', false); + $response->header('Link', '<' . config('app.url') . '/webmention>; rel="webmention"', false); return $response; } diff --git a/app/Http/Middleware/LocalhostSessionMiddleware.php b/app/Http/Middleware/LocalhostSessionMiddleware.php index 060682d5..5131b9fc 100644 --- a/app/Http/Middleware/LocalhostSessionMiddleware.php +++ b/app/Http/Middleware/LocalhostSessionMiddleware.php @@ -6,7 +6,6 @@ namespace App\Http\Middleware; use Closure; use Illuminate\Http\Request; -use Symfony\Component\HttpFoundation\Response; class LocalhostSessionMiddleware { @@ -14,8 +13,12 @@ class LocalhostSessionMiddleware * Whilst we are developing locally, automatically log in as * `['me' => config('app.url')]` as I canā€™t manually log in as * a .localhost domain. + * + * @param \Illuminate\Http\Request $request + * @param \Closure $next + * @return mixed */ - public function handle(Request $request, Closure $next): Response + public function handle(Request $request, Closure $next) { if (config('app.env') !== 'production') { session(['me' => config('app.url')]); diff --git a/app/Http/Middleware/LogMicropubRequest.php b/app/Http/Middleware/LogMicropubRequest.php deleted file mode 100644 index a04e80de..00000000 --- a/app/Http/Middleware/LogMicropubRequest.php +++ /dev/null @@ -1,24 +0,0 @@ -pushHandler(new StreamHandler(storage_path('logs/micropub.log'))); - $logger->debug('MicropubLog', $request->all()); - - return $next($request); - } -} diff --git a/app/Http/Middleware/MyAuthMiddleware.php b/app/Http/Middleware/MyAuthMiddleware.php index b22e2b33..872e6846 100644 --- a/app/Http/Middleware/MyAuthMiddleware.php +++ b/app/Http/Middleware/MyAuthMiddleware.php @@ -7,19 +7,20 @@ namespace App\Http\Middleware; use Closure; use Illuminate\Http\Request; use Illuminate\Support\Facades\Auth; -use Symfony\Component\HttpFoundation\Response; class MyAuthMiddleware { /** * Check the user is logged in. + * + * @param \Illuminate\Http\Request $request + * @param \Closure $next + * @return mixed */ - public function handle(Request $request, Closure $next): Response + public function handle(Request $request, Closure $next) { - if (Auth::check() === false) { - // theyā€™re not logged in, so send them to login form - redirect()->setIntendedUrl($request->fullUrl()); - + if (Auth::check($request->user()) == false) { + //theyā€™re not logged in, so send them to login form return redirect()->route('login'); } diff --git a/app/Http/Middleware/PreventRequestsDuringMaintenance.php b/app/Http/Middleware/PreventRequestsDuringMaintenance.php index 74cbd9a9..e4956d0b 100644 --- a/app/Http/Middleware/PreventRequestsDuringMaintenance.php +++ b/app/Http/Middleware/PreventRequestsDuringMaintenance.php @@ -9,7 +9,7 @@ class PreventRequestsDuringMaintenance extends Middleware /** * The URIs that should be reachable while maintenance mode is enabled. * - * @var array + * @var array */ protected $except = [ // diff --git a/app/Http/Middleware/RedirectIfAuthenticated.php b/app/Http/Middleware/RedirectIfAuthenticated.php index a6a6c8c4..4e0fd5c4 100644 --- a/app/Http/Middleware/RedirectIfAuthenticated.php +++ b/app/Http/Middleware/RedirectIfAuthenticated.php @@ -6,7 +6,6 @@ use App\Providers\RouteServiceProvider; use Closure; use Illuminate\Http\Request; use Illuminate\Support\Facades\Auth; -use Symfony\Component\HttpFoundation\Response; /** * @codeCoverageIgnore @@ -16,9 +15,12 @@ class RedirectIfAuthenticated /** * Handle an incoming request. * - * @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next + * @param \Illuminate\Http\Request $request + * @param \Closure $next + * @param string|null ...$guards + * @return mixed */ - public function handle(Request $request, Closure $next, string ...$guards): Response + public function handle(Request $request, Closure $next, ...$guards) { $guards = empty($guards) ? [null] : $guards; diff --git a/app/Http/Middleware/TrimStrings.php b/app/Http/Middleware/TrimStrings.php index 88cadcaa..5a50e7b5 100644 --- a/app/Http/Middleware/TrimStrings.php +++ b/app/Http/Middleware/TrimStrings.php @@ -9,10 +9,9 @@ class TrimStrings extends Middleware /** * The names of the attributes that should not be trimmed. * - * @var array + * @var array */ protected $except = [ - 'current_password', 'password', 'password_confirmation', ]; diff --git a/app/Http/Middleware/TrustHosts.php b/app/Http/Middleware/TrustHosts.php index 9c88c34c..79426404 100644 --- a/app/Http/Middleware/TrustHosts.php +++ b/app/Http/Middleware/TrustHosts.php @@ -12,9 +12,9 @@ class TrustHosts extends Middleware /** * Get the host patterns that should be trusted. * - * @return array + * @return array */ - public function hosts(): array + public function hosts() { return [ $this->allSubdomainsOfApplicationUrl(), diff --git a/app/Http/Middleware/TrustProxies.php b/app/Http/Middleware/TrustProxies.php index f33f3eef..d5563e69 100644 --- a/app/Http/Middleware/TrustProxies.php +++ b/app/Http/Middleware/TrustProxies.php @@ -10,7 +10,7 @@ class TrustProxies extends Middleware /** * The trusted proxies for this application. * - * @var array|string|null + * @var array|string */ protected $proxies; diff --git a/app/Http/Middleware/ValidateSignature.php b/app/Http/Middleware/ValidateSignature.php deleted file mode 100644 index 093bf64a..00000000 --- a/app/Http/Middleware/ValidateSignature.php +++ /dev/null @@ -1,22 +0,0 @@ - - */ - protected $except = [ - // 'fbclid', - // 'utm_campaign', - // 'utm_content', - // 'utm_medium', - // 'utm_source', - // 'utm_term', - ]; -} diff --git a/app/Http/Middleware/VerifyCsrfToken.php b/app/Http/Middleware/VerifyCsrfToken.php index fc7bad50..1593e373 100644 --- a/app/Http/Middleware/VerifyCsrfToken.php +++ b/app/Http/Middleware/VerifyCsrfToken.php @@ -9,7 +9,7 @@ class VerifyCsrfToken extends Middleware /** * The URIs that should be excluded from CSRF verification. * - * @var array + * @var array */ protected $except = [ 'api/media', diff --git a/app/Http/Middleware/VerifyMicropubToken.php b/app/Http/Middleware/VerifyMicropubToken.php index 33d2cb12..aa650560 100644 --- a/app/Http/Middleware/VerifyMicropubToken.php +++ b/app/Http/Middleware/VerifyMicropubToken.php @@ -4,78 +4,34 @@ declare(strict_types=1); namespace App\Http\Middleware; -use App\Http\Responses\MicropubResponses; use Closure; use Illuminate\Http\Request; -use Lcobucci\JWT\Configuration; -use Lcobucci\JWT\Encoding\CannotDecodeContent; -use Lcobucci\JWT\Token; -use Lcobucci\JWT\Token\InvalidTokenStructure; -use Lcobucci\JWT\Validation\RequiredConstraintsViolated; -use Symfony\Component\HttpFoundation\Response; class VerifyMicropubToken { /** * Handle an incoming request. * - * @param Closure(Request): (Response) $next + * @param \Illuminate\Http\Request $request + * @param \Closure $next + * @return mixed */ - public function handle(Request $request, Closure $next): Response + public function handle(Request $request, Closure $next) { - $rawToken = null; - if ($request->input('access_token')) { - $rawToken = $request->input('access_token'); - } elseif ($request->bearerToken()) { - $rawToken = $request->bearerToken(); + return $next($request); } - if (! $rawToken) { - return response()->json([ - 'response' => 'error', - 'error' => 'unauthorized', - 'error_description' => 'No access token was provided in the request', - ], 401); + if ($request->bearerToken()) { + return $next($request->merge([ + 'access_token' => $request->bearerToken(), + ])); } - try { - $tokenData = $this->validateToken($rawToken); - } catch (RequiredConstraintsViolated|InvalidTokenStructure|CannotDecodeContent) { - $micropubResponses = new MicropubResponses; - - return $micropubResponses->invalidTokenResponse(); - } - - if ($tokenData->claims()->has('scope') === false) { - $micropubResponses = new MicropubResponses; - - return $micropubResponses->tokenHasNoScopeResponse(); - } - - return $next($request->merge([ - 'access_token' => $rawToken, - 'token_data' => [ - 'me' => $tokenData->claims()->get('me'), - 'scope' => $tokenData->claims()->get('scope'), - 'client_id' => $tokenData->claims()->get('client_id'), - ], - ])); - } - - /** - * Check the token signature is valid. - */ - private function validateToken(string $bearerToken): Token - { - $config = resolve(Configuration::class); - - $token = $config->parser()->parse($bearerToken); - - $constraints = $config->validationConstraints(); - - $config->validator()->assert($token, ...$constraints); - - return $token; + return response()->json([ + 'response' => 'error', + 'error' => 'unauthorized', + 'error_description' => 'No access token was provided in the request', + ], 401); } } diff --git a/app/Http/Requests/MicropubRequest.php b/app/Http/Requests/MicropubRequest.php deleted file mode 100644 index d931f139..00000000 --- a/app/Http/Requests/MicropubRequest.php +++ /dev/null @@ -1,106 +0,0 @@ -micropubData; - } - - public function getType(): ?string - { - // Return consistent type regardless of input format - return $this->micropubData['type'] ?? null; - } - - protected function prepareForValidation(): void - { - // Normalize the request data based on content type - if ($this->isJson()) { - $this->normalizeMicropubJson(); - } else { - $this->normalizeMicropubForm(); - } - } - - private function normalizeMicropubJson(): void - { - $json = $this->json(); - if ($json === null) { - throw new \InvalidArgumentException('`isJson()` passed but there is no json data'); - } - - $data = $json->all(); - - // Convert JSON type (h-entry) to simple type (entry) - if (isset($data['type']) && is_array($data['type'])) { - $type = current($data['type']); - if (strpos($type, 'h-') === 0) { - $this->micropubData['type'] = substr($type, 2); - } - } - // Or set the type to update - elseif (isset($data['action']) && $data['action'] === 'update') { - $this->micropubData['type'] = 'update'; - } - - // Add in the token data - $this->micropubData['token_data'] = $data['token_data']; - - // Add h-entry values - $this->micropubData['content'] = Arr::get($data, 'properties.content.0'); - $this->micropubData['in-reply-to'] = Arr::get($data, 'properties.in-reply-to.0'); - $this->micropubData['published'] = Arr::get($data, 'properties.published.0'); - $this->micropubData['location'] = Arr::get($data, 'location'); - $this->micropubData['bookmark-of'] = Arr::get($data, 'properties.bookmark-of.0'); - $this->micropubData['like-of'] = Arr::get($data, 'properties.like-of.0'); - $this->micropubData['mp-syndicate-to'] = Arr::get($data, 'properties.mp-syndicate-to'); - - // Add h-card values - $this->micropubData['name'] = Arr::get($data, 'properties.name.0'); - $this->micropubData['description'] = Arr::get($data, 'properties.description.0'); - $this->micropubData['geo'] = Arr::get($data, 'properties.geo.0'); - - // Add checkin value - $this->micropubData['checkin'] = Arr::get($data, 'checkin'); - $this->micropubData['syndication'] = Arr::get($data, 'properties.syndication.0'); - } - - private function normalizeMicropubForm(): void - { - // Convert form h=entry to type=entry - if ($h = $this->input('h')) { - $this->micropubData['type'] = $h; - } - - // Add some fields to the micropub data with default null values - $this->micropubData['in-reply-to'] = null; - $this->micropubData['published'] = null; - $this->micropubData['location'] = null; - $this->micropubData['description'] = null; - $this->micropubData['geo'] = null; - $this->micropubData['latitude'] = null; - $this->micropubData['longitude'] = null; - - // Map form fields to micropub data - foreach ($this->except(['h', 'access_token']) as $key => $value) { - $this->micropubData[$key] = $value; - } - } -} diff --git a/app/Http/Responses/MicropubResponses.php b/app/Http/Responses/MicropubResponses.php index 4f7240c2..829e5c57 100644 --- a/app/Http/Responses/MicropubResponses.php +++ b/app/Http/Responses/MicropubResponses.php @@ -10,6 +10,8 @@ class MicropubResponses { /** * Generate a response to be returned when the token has insufficient scope. + * + * @return JsonResponse */ public function insufficientScopeResponse(): JsonResponse { @@ -22,6 +24,8 @@ class MicropubResponses /** * Generate a response to be returned when the token is invalid. + * + * @return JsonResponse */ public function invalidTokenResponse(): JsonResponse { @@ -34,6 +38,8 @@ class MicropubResponses /** * Generate a response to be returned when the token has no scope. + * + * @return JsonResponse */ public function tokenHasNoScopeResponse(): JsonResponse { diff --git a/app/Jobs/AddClientToDatabase.php b/app/Jobs/AddClientToDatabase.php index b540aac0..a3611d00 100644 --- a/app/Jobs/AddClientToDatabase.php +++ b/app/Jobs/AddClientToDatabase.php @@ -18,22 +18,26 @@ class AddClientToDatabase implements ShouldQueue use Queueable; use SerializesModels; - protected string $client_id; + protected $client_id; /** * Create a new job instance. + * + * @param string $client_id */ - public function __construct(string $clientId) + public function __construct(string $client_id) { - $this->client_id = $clientId; + $this->client_id = $client_id; } /** * Execute the job. + * + * @return void */ - public function handle(): void + public function handle() { - if (MicropubClient::where('client_url', $this->client_id)->count() === 0) { + if (MicropubClient::where('client_url', $this->client_id)->count() == 0) { MicropubClient::create([ 'client_url' => $this->client_id, 'client_name' => $this->client_id, // default client name is the URL diff --git a/app/Jobs/DownloadWebMention.php b/app/Jobs/DownloadWebMention.php index 3c187dd4..bb47f654 100644 --- a/app/Jobs/DownloadWebMention.php +++ b/app/Jobs/DownloadWebMention.php @@ -20,47 +20,59 @@ class DownloadWebMention implements ShouldQueue use SerializesModels; /** - * Create a new job instance. + * The webmention source URL. + * + * @var string */ - public function __construct( - protected string $source - ) {} + protected $source; + + /** + * Create a new job instance. + * + * @param string $source + */ + public function __construct(string $source) + { + $this->source = $source; + } /** * Execute the job. * + * @param Client $guzzle + * * @throws GuzzleException * @throws FileNotFoundException */ - public function handle(Client $guzzle): void + public function handle(Client $guzzle) { $response = $guzzle->request('GET', $this->source); - // 4XX and 5XX responses should get Guzzle to throw an exception, - // Laravel should catch and retry these automatically. - if ($response->getStatusCode() === 200) { - $filesystem = new FileSystem; + //4XX and 5XX responses should get Guzzle to throw an exception, + //Laravel should catch and retry these automatically. + if ($response->getStatusCode() == '200') { + $filesystem = new FileSystem(); $filename = storage_path('HTML') . '/' . $this->createFilenameFromURL($this->source); - // backup file first + //backup file first $filenameBackup = $filename . '.' . date('Y-m-d') . '.backup'; if ($filesystem->exists($filename)) { $filesystem->copy($filename, $filenameBackup); } - // check if base directory exists + //check if base directory exists if (! $filesystem->exists($filesystem->dirname($filename))) { $filesystem->makeDirectory( $filesystem->dirname($filename), - 0755, // mode - true // recursive + 0755, //mode + true //recursive ); } - // save new HTML + //save new HTML $filesystem->put( $filename, (string) $response->getBody() ); - // remove backup if the same + //remove backup if the same if ($filesystem->exists($filenameBackup)) { - if ($filesystem->get($filename) === $filesystem->get($filenameBackup)) { + if ($filesystem->get($filename) == $filesystem->get($filenameBackup)) { $filesystem->delete($filenameBackup); } } @@ -69,11 +81,14 @@ class DownloadWebMention implements ShouldQueue /** * Create a file path from a URL. This is used when caching the HTML response. + * + * @param string $url + * @return string The path name */ - private function createFilenameFromURL(string $url): string + private function createFilenameFromURL(string $url) { $filepath = str_replace(['https://', 'http://'], ['https/', 'http/'], $url); - if (str_ends_with($filepath, '/')) { + if (substr($filepath, -1) == '/') { $filepath .= 'index.html'; } diff --git a/app/Jobs/ProcessBookmark.php b/app/Jobs/ProcessBookmark.php index 96f65e87..ce7d7637 100644 --- a/app/Jobs/ProcessBookmark.php +++ b/app/Jobs/ProcessBookmark.php @@ -20,23 +20,32 @@ class ProcessBookmark implements ShouldQueue use Queueable; use SerializesModels; + /** @var Bookmark */ + protected $bookmark; + /** * Create a new job instance. + * + * @param Bookmark $bookmark */ - public function __construct( - protected Bookmark $bookmark - ) {} + public function __construct(Bookmark $bookmark) + { + $this->bookmark = $bookmark; + } /** * Execute the job. + * + * @return void */ - public function handle(): void + public function handle() { - SaveScreenshot::dispatch($this->bookmark); + $uuid = (resolve(BookmarkService::class))->saveScreenshot($this->bookmark->url); + $this->bookmark->screenshot = $uuid; try { $archiveLink = (resolve(BookmarkService::class))->getArchiveLink($this->bookmark->url); - } catch (InternetArchiveException) { + } catch (InternetArchiveException $e) { $archiveLink = null; } $this->bookmark->archive = $archiveLink; diff --git a/app/Jobs/ProcessLike.php b/app/Jobs/ProcessLike.php index 3c6028a9..6a5281c0 100644 --- a/app/Jobs/ProcessLike.php +++ b/app/Jobs/ProcessLike.php @@ -25,16 +25,26 @@ class ProcessLike implements ShouldQueue use Queueable; use SerializesModels; + /** @var Like */ + protected $like; + /** * Create a new job instance. + * + * @param Like $like */ - public function __construct( - protected Like $like - ) {} + public function __construct(Like $like) + { + $this->like = $like; + } /** * Execute the job. * + * @param Client $client + * @param Authorship $authorship + * @return int + * * @throws GuzzleException */ public function handle(Client $client, Authorship $authorship): int @@ -49,7 +59,7 @@ class ProcessLike implements ShouldQueue $this->like->content = $tweet->html; $this->like->save(); - // POSSE like + //POSSE like try { $client->request( 'POST', @@ -94,6 +104,9 @@ class ProcessLike implements ShouldQueue /** * Determine if a given URL is that of a Tweet. + * + * @param string $url + * @return bool */ private function isTweet(string $url): bool { diff --git a/app/Jobs/ProcessMedia.php b/app/Jobs/ProcessMedia.php index b7f36648..5872e33e 100644 --- a/app/Jobs/ProcessMedia.php +++ b/app/Jobs/ProcessMedia.php @@ -10,7 +10,7 @@ use Illuminate\Foundation\Bus\Dispatchable; use Illuminate\Queue\InteractsWithQueue; use Illuminate\Queue\SerializesModels; use Illuminate\Support\Facades\Storage; -use Intervention\Image\Exceptions\DecoderException; +use Intervention\Image\Exception\NotReadableException; use Intervention\Image\ImageManager; class ProcessMedia implements ShouldQueue @@ -20,50 +20,55 @@ class ProcessMedia implements ShouldQueue use Queueable; use SerializesModels; + /** @var string */ + protected $filename; + /** * Create a new job instance. + * + * @param string $filename */ - public function __construct( - protected string $filename - ) {} + public function __construct(string $filename) + { + $this->filename = $filename; + } /** * Execute the job. + * + * @param ImageManager $manager */ - public function handle(ImageManager $manager): void + public function handle(ImageManager $manager) { - // Load file - $file = Storage::disk('local')->get('media/' . $this->filename); - - // Open file + //open file try { - $image = $manager->read($file); - } catch (DecoderException) { + $image = $manager->make(storage_path('app') . '/' . $this->filename); + } catch (NotReadableException $exception) { // not an image; delete file and end job - Storage::disk('local')->delete('media/' . $this->filename); + unlink(storage_path('app') . '/' . $this->filename); return; } - - // Save the file publicly - Storage::disk('public')->put('media/' . $this->filename, $file); - - // Create smaller versions if necessary + //create smaller versions if necessary if ($image->width() > 1000) { $filenameParts = explode('.', $this->filename); $extension = array_pop($filenameParts); // the following achieves this data flow // foo.bar.png => ['foo', 'bar', 'png'] => ['foo', 'bar'] => foo.bar - $basename = trim(implode('.', $filenameParts), '.'); - - $medium = $image->resize(width: 1000); - Storage::disk('public')->put('media/' . $basename . '-medium.' . $extension, (string) $medium->encode()); - - $small = $image->resize(width: 500); - Storage::disk('public')->put('media/' . $basename . '-small.' . $extension, (string) $small->encode()); + $basename = ltrim(array_reduce($filenameParts, function ($carry, $item) { + return $carry . '.' . $item; + }, ''), '.'); + $medium = $image->resize(1000, null, function ($constraint) { + $constraint->aspectRatio(); + }); + Storage::disk('s3')->put('media/' . $basename . '-medium.' . $extension, (string) $medium->encode()); + $small = $image->resize(500, null, function ($constraint) { + $constraint->aspectRatio(); + }); + Storage::disk('s3')->put('media/' . $basename . '-small.' . $extension, (string) $small->encode()); } - // Now we can delete the locally saved image - Storage::disk('local')->delete('media/' . $this->filename); + // now we can delete the locally saved image + unlink(storage_path('app') . '/' . $this->filename); } } diff --git a/app/Jobs/ProcessWebMention.php b/app/Jobs/ProcessWebMention.php index d92dfa18..82636ec6 100644 --- a/app/Jobs/ProcessWebMention.php +++ b/app/Jobs/ProcessWebMention.php @@ -24,27 +24,40 @@ class ProcessWebMention implements ShouldQueue use Queueable; use SerializesModels; + /** @var Note */ + protected $note; + + /** @var string */ + protected $source; + /** * Create a new job instance. + * + * @param Note $note + * @param string $source */ - public function __construct( - protected Note $note, - protected string $source - ) {} + public function __construct(Note $note, string $source) + { + $this->note = $note; + $this->source = $source; + } /** * Execute the job. * + * @param Parser $parser + * @param Client $guzzle + * * @throws RemoteContentNotFoundException * @throws GuzzleException * @throws InvalidMentionException */ - public function handle(Parser $parser, Client $guzzle): void + public function handle(Parser $parser, Client $guzzle) { try { $response = $guzzle->request('GET', $this->source); } catch (RequestException $e) { - throw new RemoteContentNotFoundException; + throw new RemoteContentNotFoundException(); } $this->saveRemoteContent((string) $response->getBody(), $this->source); $microformats = Mf2\parse((string) $response->getBody(), $this->source); @@ -52,8 +65,8 @@ class ProcessWebMention implements ShouldQueue foreach ($webmentions as $webmention) { // check webmention still references target // we try each type of mention (reply/like/repost) - if ($webmention->type === 'in-reply-to') { - if ($parser->checkInReplyTo($microformats, $this->note->uri) === false) { + if ($webmention->type == 'in-reply-to') { + if ($parser->checkInReplyTo($microformats, $this->note->longurl) == false) { // it doesnā€™t so delete $webmention->delete(); @@ -66,16 +79,16 @@ class ProcessWebMention implements ShouldQueue return; } - if ($webmention->type === 'like-of') { - if ($parser->checkLikeOf($microformats, $this->note->uri) === false) { + if ($webmention->type == 'like-of') { + if ($parser->checkLikeOf($microformats, $this->note->longurl) == false) { // it doesnā€™t so delete $webmention->delete(); return; } // note we donā€™t need to do anything if it still is a like } - if ($webmention->type === 'repost-of') { - if ($parser->checkRepostOf($microformats, $this->note->uri) === false) { + if ($webmention->type == 'repost-of') { + if ($parser->checkRepostOf($microformats, $this->note->longurl) == false) { // it doesnā€™t so delete $webmention->delete(); @@ -85,13 +98,13 @@ class ProcessWebMention implements ShouldQueue }// foreach // no webmention in the db so create new one - $webmention = new WebMention; + $webmention = new WebMention(); $type = $parser->getMentionType($microformats); // throw error here? dispatch(new SaveProfileImage($microformats)); $webmention->source = $this->source; - $webmention->target = $this->note->uri; + $webmention->target = $this->note->longurl; $webmention->commentable_id = $this->note->id; - $webmention->commentable_type = Note::class; + $webmention->commentable_type = 'App\Model\Note'; $webmention->type = $type; $webmention->mf2 = json_encode($microformats); $webmention->save(); @@ -99,23 +112,26 @@ class ProcessWebMention implements ShouldQueue /** * Save the HTML of a webmention for future use. + * + * @param string $html + * @param string $url */ - private function saveRemoteContent(string $html, string $url): void + private function saveRemoteContent($html, $url) { $filenameFromURL = str_replace( ['https://', 'http://'], ['https/', 'http/'], $url ); - if (str_ends_with($url, '/')) { + if (substr($url, -1) == '/') { $filenameFromURL .= 'index.html'; } $path = storage_path() . '/HTML/' . $filenameFromURL; $parts = explode('/', $path); $name = array_pop($parts); $dir = implode('/', $parts); - if (! is_dir($dir) && ! mkdir($dir, 0755, true) && ! is_dir($dir)) { - throw new \RuntimeException(sprintf('Directory "%s" was not created', $dir)); + if (! is_dir($dir)) { + mkdir($dir, 0755, true); } file_put_contents("$dir/$name", $html); } diff --git a/app/Jobs/SaveProfileImage.php b/app/Jobs/SaveProfileImage.php index 08152d5b..38dbfc4c 100644 --- a/app/Jobs/SaveProfileImage.php +++ b/app/Jobs/SaveProfileImage.php @@ -20,40 +20,39 @@ class SaveProfileImage implements ShouldQueue use Queueable; use SerializesModels; + protected array $microformats; + /** * Create a new job instance. + * + * @param array $microformats */ - public function __construct( - protected array $microformats - ) {} + public function __construct(array $microformats) + { + $this->microformats = $microformats; + } /** * Execute the job. + * + * @param Authorship $authorship */ - public function handle(Authorship $authorship): void + public function handle(Authorship $authorship) { try { $author = $authorship->findAuthor($this->microformats); } catch (AuthorshipParserException) { - return; + return null; } $photo = Arr::get($author, 'properties.photo.0'); $home = Arr::get($author, 'properties.url.0'); - if (is_array($photo) && array_key_exists('value', $photo)) { - $photo = $photo['value']; - } - - if (is_array($home)) { - $home = array_shift($home); - } - - // dont save pbs.twimg.com links + //dont save pbs.twimg.com links if ( $photo - && parse_url($photo, PHP_URL_HOST) !== 'pbs.twimg.com' - && parse_url($photo, PHP_URL_HOST) !== 'twitter.com' + && parse_url($photo, PHP_URL_HOST) != 'pbs.twimg.com' + && parse_url($photo, PHP_URL_HOST) != 'twitter.com' ) { $client = resolve(Client::class); @@ -72,8 +71,8 @@ class SaveProfileImage implements ShouldQueue $parts = explode('/', $path); $name = array_pop($parts); $dir = implode('/', $parts); - if (! is_dir($dir) && ! mkdir($dir, 0755, true) && ! is_dir($dir)) { - throw new \RuntimeException(sprintf('Directory "%s" was not created', $dir)); + if (! is_dir($dir)) { + mkdir($dir, 0755, true); } file_put_contents("$dir/$name", $image); } diff --git a/app/Jobs/SaveScreenshot.php b/app/Jobs/SaveScreenshot.php deleted file mode 100755 index 0e07efbd..00000000 --- a/app/Jobs/SaveScreenshot.php +++ /dev/null @@ -1,103 +0,0 @@ -request('POST', 'https://api.cloudconvert.com/v2/capture-website', [ - 'headers' => [ - 'Authorization' => 'Bearer ' . config('services.cloudconvert.token'), - ], - 'json' => [ - 'url' => $this->bookmark->url, - 'output_format' => 'png', - 'screen_width' => 1440, - 'screen_height' => 900, - 'wait_until' => 'networkidle0', - 'wait_time' => 100, - ], - ]); - - $taskId = json_decode($takeScreenshotJobResponse->getBody()->getContents(), false, 512, JSON_THROW_ON_ERROR)->data->id; - - // Now wait till the status job is finished - $screenshotJobStatusResponse = $retryClient->request('GET', 'https://api.cloudconvert.com/v2/tasks/' . $taskId, [ - 'headers' => [ - 'Authorization' => 'Bearer ' . config('services.cloudconvert.token'), - ], - 'query' => [ - 'include' => 'payload', - ], - ]); - - $finishedCaptureId = json_decode($screenshotJobStatusResponse->getBody()->getContents(), false, 512, JSON_THROW_ON_ERROR)->data->id; - - // Now we can create a new job to request thst the screenshot is exported to a temporary URL we can download the screenshot from - $exportImageJob = $client->request('POST', 'https://api.cloudconvert.com/v2/export/url', [ - 'headers' => [ - 'Authorization' => 'Bearer ' . config('services.cloudconvert.token'), - ], - 'json' => [ - 'input' => $finishedCaptureId, - 'archive_multiple_files' => false, - ], - ]); - - $exportImageJobId = json_decode($exportImageJob->getBody()->getContents(), false, 512, JSON_THROW_ON_ERROR)->data->id; - - // Again, wait till the status of this export job is finished - $finalImageUrlResponse = $retryClient->request('GET', 'https://api.cloudconvert.com/v2/tasks/' . $exportImageJobId, [ - 'headers' => [ - 'Authorization' => 'Bearer ' . config('services.cloudconvert.token'), - ], - 'query' => [ - 'include' => 'payload', - ], - ]); - - // Now we can download the screenshot and save it to the storage - $finalImageUrl = json_decode($finalImageUrlResponse->getBody()->getContents(), false, 512, JSON_THROW_ON_ERROR)->data->result->files[0]->url; - - $finalImageUrlContent = $client->request('GET', $finalImageUrl); - - Storage::disk('public')->put('/assets/img/bookmarks/' . $taskId . '.png', $finalImageUrlContent->getBody()->getContents()); - - $this->bookmark->screenshot = $taskId; - $this->bookmark->save(); - } -} diff --git a/app/Jobs/SendWebMentions.php b/app/Jobs/SendWebMentions.php index 2ff5f2c6..92267d18 100644 --- a/app/Jobs/SendWebMentions.php +++ b/app/Jobs/SendWebMentions.php @@ -6,8 +6,8 @@ namespace App\Jobs; use App\Models\Note; use GuzzleHttp\Client; -use GuzzleHttp\Exception\GuzzleException; use GuzzleHttp\Psr7\Header; +use GuzzleHttp\Psr7\Uri; use GuzzleHttp\Psr7\UriResolver; use GuzzleHttp\Psr7\Utils; use Illuminate\Bus\Queueable; @@ -22,30 +22,39 @@ class SendWebMentions implements ShouldQueue use Queueable; use SerializesModels; + /** @var Note */ + protected $note; + /** - * Create a new job instance. + * Create the job instance, inject dependencies. + * + * @param Note $note */ - public function __construct( - protected Note $note - ) {} + public function __construct(Note $note) + { + $this->note = $note; + } /** * Execute the job. * - * @throws GuzzleException + * @return void */ - public function handle(): void + public function handle() { - $urlsInReplyTo = explode(' ', $this->note->in_reply_to ?? ''); + //grab the URLs + $inReplyTo = $this->note->in_reply_to ?? ''; + // above so explode doesnā€™t complain about null being passed in + $urlsInReplyTo = explode(' ', $inReplyTo); $urlsNote = $this->getLinks($this->note->note); - $urls = array_filter(array_merge($urlsInReplyTo, $urlsNote)); + $urls = array_filter(array_merge($urlsInReplyTo, $urlsNote)); //filter out none URLs foreach ($urls as $url) { $endpoint = $this->discoverWebmentionEndpoint($url); if ($endpoint !== null) { $guzzle = resolve(Client::class); $guzzle->post($endpoint, [ 'form_params' => [ - 'source' => $this->note->uri, + 'source' => $this->note->longurl, 'target' => $url, ], ]); @@ -56,12 +65,13 @@ class SendWebMentions implements ShouldQueue /** * Discover if a URL has a webmention endpoint. * - * @throws GuzzleException + * @param string $url + * @return string|null */ public function discoverWebmentionEndpoint(string $url): ?string { - // letā€™s not send webmentions to myself - if (parse_url($url, PHP_URL_HOST) === parse_url(config('app.url'), PHP_URL_HOST)) { + //letā€™s not send webmentions to myself + if (parse_url($url, PHP_URL_HOST) === config('app.longurl')) { return null; } if (Str::startsWith($url, '/notes/tagged/')) { @@ -72,15 +82,15 @@ class SendWebMentions implements ShouldQueue $guzzle = resolve(Client::class); $response = $guzzle->get($url); - // check HTTP Headers for webmention endpoint + //check HTTP Headers for webmention endpoint $links = Header::parse($response->getHeader('Link')); foreach ($links as $link) { - if (array_key_exists('rel', $link) && mb_stristr($link['rel'], 'webmention')) { + if (mb_stristr($link['rel'], 'webmention')) { return $this->resolveUri(trim($link[0], '<>'), $url); } } - // failed to find a header so parse HTML + //failed to find a header so parse HTML $html = (string) $response->getBody(); $mf2 = new \Mf2\Parser($html, $url); @@ -100,6 +110,9 @@ class SendWebMentions implements ShouldQueue /** * Get the URLs from a note. + * + * @param string|null $html + * @return array */ public function getLinks(?string $html): array { @@ -108,7 +121,7 @@ class SendWebMentions implements ShouldQueue } $urls = []; - $dom = new \DOMDocument; + $dom = new \DOMDocument(); $dom->loadHTML($html); $anchors = $dom->getElementsByTagName('a'); foreach ($anchors as $anchor) { @@ -120,6 +133,12 @@ class SendWebMentions implements ShouldQueue /** * Resolve a URI if necessary. + * + * @todo Update deprecated resolve method + * + * @param string $url + * @param string $base The base of the URL + * @return string */ public function resolveUri(string $url, string $base): string { diff --git a/app/Jobs/SyndicateBookmarkToTwitter.php b/app/Jobs/SyndicateBookmarkToTwitter.php new file mode 100644 index 00000000..1e76a90d --- /dev/null +++ b/app/Jobs/SyndicateBookmarkToTwitter.php @@ -0,0 +1,66 @@ +bookmark = $bookmark; + } + + /** + * Execute the job. + * + * @param Client $guzzle + * + * @throws GuzzleException + */ + public function handle(Client $guzzle) + { + //send webmention + $response = $guzzle->request( + 'POST', + 'https://brid.gy/publish/webmention', + [ + 'form_params' => [ + 'source' => $this->bookmark->longurl, + 'target' => 'https://brid.gy/publish/twitter', + 'bridgy_omit_link' => 'maybe', + ], + ] + ); + //parse for syndication URL + if ($response->getStatusCode() == 201) { + $json = json_decode((string) $response->getBody()); + $syndicates = $this->bookmark->syndicates; + $syndicates['twitter'] = $json->url; + $this->bookmark->syndicates = $syndicates; + $this->bookmark->save(); + } + } +} diff --git a/app/Jobs/SyndicateNoteToBluesky.php b/app/Jobs/SyndicateNoteToBluesky.php deleted file mode 100644 index e815be34..00000000 --- a/app/Jobs/SyndicateNoteToBluesky.php +++ /dev/null @@ -1,62 +0,0 @@ -request( - 'POST', - 'https://brid.gy/micropub', - [ - 'headers' => [ - 'Authorization' => 'Bearer ' . config('bridgy.bluesky_token'), - ], - 'json' => [ - 'type' => ['h-entry'], - 'properties' => [ - 'content' => [$this->note->getRawOriginal('note')], - ], - ], - ] - ); - - // Parse for syndication URL - if ($response->getStatusCode() === 201) { - $this->note->bluesky_url = $response->getHeader('Location')[0]; - $this->note->save(); - } - } -} diff --git a/app/Jobs/SyndicateNoteToMastodon.php b/app/Jobs/SyndicateNoteToMastodon.php index b79c092c..87050413 100644 --- a/app/Jobs/SyndicateNoteToMastodon.php +++ b/app/Jobs/SyndicateNoteToMastodon.php @@ -19,14 +19,21 @@ class SyndicateNoteToMastodon implements ShouldQueue /** * Create a new job instance. + * + * @param Note $note + * @return void */ public function __construct( protected Note $note - ) {} + ) { + } /** * Execute the job. * + * @param Client $guzzle + * @return void + * * @throws GuzzleException */ public function handle(Client $guzzle): void diff --git a/app/Jobs/SyndicateNoteToTwitter.php b/app/Jobs/SyndicateNoteToTwitter.php new file mode 100644 index 00000000..4b8d9c1e --- /dev/null +++ b/app/Jobs/SyndicateNoteToTwitter.php @@ -0,0 +1,63 @@ +note = $note; + } + + /** + * Execute the job. + * + * @param Client $guzzle + * + * @throws GuzzleException + */ + public function handle(Client $guzzle) + { + //send webmention + $response = $guzzle->request( + 'POST', + 'https://brid.gy/publish/webmention', + [ + 'form_params' => [ + 'source' => $this->note->longurl, + 'target' => 'https://brid.gy/publish/twitter', + 'bridgy_omit_link' => 'maybe', + ], + ] + ); + //parse for syndication URL + if ($response->getStatusCode() == 201) { + $json = json_decode((string) $response->getBody()); + $tweet_id = basename(parse_url($json->url, PHP_URL_PATH)); + $this->note->tweet_id = $tweet_id; + $this->note->save(); + } + } +} diff --git a/app/Models/Article.php b/app/Models/Article.php index bfbd5d51..0aac8d7f 100644 --- a/app/Models/Article.php +++ b/app/Models/Article.php @@ -6,7 +6,6 @@ namespace App\Models; use Cviebrock\EloquentSluggable\Sluggable; use Illuminate\Database\Eloquent\Builder; -use Illuminate\Database\Eloquent\Casts\Attribute; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\SoftDeletes; @@ -24,26 +23,24 @@ class Article extends Model use Sluggable; use SoftDeletes; - /** @var string */ + /** + * The attributes that should be mutated to dates. + * + * @var array + */ + protected $dates = ['created_at', 'updated_at', 'deleted_at']; + + /** + * The database table used by the model. + * + * @var string + */ protected $table = 'articles'; - /** @var array */ - protected $fillable = [ - 'url', - 'title', - 'main', - 'published', - ]; - - /** @var array */ - protected $casts = [ - 'created_at' => 'datetime', - 'updated_at' => 'datetime', - 'deleted_at' => 'datetime', - ]; - /** * Return the sluggable configuration array for this model. + * + * @return array */ public function sluggable(): array { @@ -54,62 +51,90 @@ class Article extends Model ]; } - protected function html(): Attribute - { - return Attribute::get( - get: function () { - $environment = new Environment; - $environment->addExtension(new CommonMarkCoreExtension); - $environment->addRenderer(FencedCode::class, new FencedCodeRenderer); - $environment->addRenderer(IndentedCode::class, new IndentedCodeRenderer); - $markdownConverter = new MarkdownConverter($environment); + /** + * We shall set a blacklist of non-modifiable model attributes. + * + * @var array + */ + protected $guarded = ['id']; - return $markdownConverter->convert($this->main)->getContent(); - }, - ); + /** + * Process the article for display. + * + * @return string + */ + public function getHtmlAttribute(): string + { + $environment = new Environment(); + $environment->addExtension(new CommonMarkCoreExtension()); + $environment->addRenderer(FencedCode::class, new FencedCodeRenderer()); + $environment->addRenderer(IndentedCode::class, new IndentedCodeRenderer()); + $markdownConverter = new MarkdownConverter($environment); + + return $markdownConverter->convert($this->main)->getContent(); } - protected function w3cTime(): Attribute + /** + * Convert updated_at to W3C time format. + * + * @return string + */ + public function getW3cTimeAttribute(): string { - return Attribute::get( - get: fn () => $this->updated_at->toW3CString(), - ); + return $this->updated_at->toW3CString(); } - protected function tooltipTime(): Attribute + /** + * Convert updated_at to a tooltip appropriate format. + * + * @return string + */ + public function getTooltipTimeAttribute(): string { - return Attribute::get( - get: fn () => $this->updated_at->toRFC850String(), - ); + return $this->updated_at->toRFC850String(); } - protected function humanTime(): Attribute + /** + * Convert updated_at to a human readable format. + * + * @return string + */ + public function getHumanTimeAttribute(): string { - return Attribute::get( - get: fn () => $this->updated_at->diffForHumans(), - ); + return $this->updated_at->diffForHumans(); } - protected function pubdate(): Attribute + /** + * Get the pubdate value for RSS feeds. + * + * @return string + */ + public function getPubdateAttribute(): string { - return Attribute::get( - get: fn () => $this->updated_at->toRSSString(), - ); + return $this->updated_at->toRSSString(); } - protected function link(): Attribute + /** + * A link to the article, i.e. `/blog/1999/12/25/merry-christmas`. + * + * @return string + */ + public function getLinkAttribute(): string { - return Attribute::get( - get: fn () => '/blog/' . $this->updated_at->year . '/' . $this->updated_at->format('m') . '/' . $this->titleurl, - ); + return '/blog/' . $this->updated_at->year . '/' . $this->updated_at->format('m') . '/' . $this->titleurl; } /** * Scope a query to only include articles from a particular year/month. + * + * @param Builder $query + * @param int|null $year + * @param int|null $month + * @return Builder */ - public function scopeDate(Builder $query, ?int $year = null, ?int $month = null): Builder + public function scopeDate(Builder $query, int $year = null, int $month = null): Builder { - if ($year === null) { + if ($year == null) { return $query; } $start = $year . '-01-01 00:00:00'; diff --git a/app/Models/Bio.php b/app/Models/Bio.php deleted file mode 100644 index b9a0e78b..00000000 --- a/app/Models/Bio.php +++ /dev/null @@ -1,11 +0,0 @@ - */ + /** + * The attributes that are mass assignable. + * + * @var array + */ protected $fillable = ['url', 'name', 'content']; - /** @var array */ + /** + * The attributes that should be cast to native types. + * + * @var array + */ protected $casts = [ 'syndicates' => 'array', ]; - public function tags(): BelongsToMany + /** + * The tags that belong to the bookmark. + * + * @return BelongsToMany + */ + public function tags() { return $this->belongsToMany('App\Models\Tag'); } - protected function local_uri(): Attribute + /** + * The full url of a bookmark. + * + * @return string + */ + public function getLongurlAttribute(): string { - return Attribute::get( - get: fn () => config('app.url') . '/bookmarks/' . $this->id, - ); + return config('app.url') . '/bookmarks/' . $this->id; } } diff --git a/app/Models/Contact.php b/app/Models/Contact.php index 6f193f41..1da4d7ba 100644 --- a/app/Models/Contact.php +++ b/app/Models/Contact.php @@ -12,10 +12,18 @@ class Contact extends Model { use HasFactory; - /** @var string */ + /** + * The database table used by the model. + * + * @var string + */ protected $table = 'contacts'; - /** @var array */ + /** + * We shall guard against mass-migration. + * + * @var array + */ protected $fillable = ['nick', 'name', 'homepage', 'twitter', 'facebook']; protected function photo(): Attribute diff --git a/app/Models/Like.php b/app/Models/Like.php index f9ac3bcb..c7a17448 100644 --- a/app/Models/Like.php +++ b/app/Models/Like.php @@ -5,7 +5,6 @@ declare(strict_types=1); namespace App\Models; use App\Traits\FilterHtml; -use Illuminate\Database\Eloquent\Casts\Attribute; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Arr; @@ -16,41 +15,48 @@ class Like extends Model use FilterHtml; use HasFactory; - /** @var array */ protected $fillable = ['url']; - protected function url(): Attribute + /** + * Normalize the URL of a Like. + * + * @param string $value The provided URL + */ + public function setUrlAttribute(string $value) { - return Attribute::set( - set: fn ($value) => normalize_url($value), - ); + $this->attributes['url'] = normalize_url($value); } - protected function authorUrl(): Attribute + /** + * Normalize the URL of the author of the like. + * + * @param string|null $value The authorā€™s url + */ + public function setAuthorUrlAttribute(?string $value) { - return Attribute::set( - set: fn ($value) => normalize_url($value), - ); + $this->attributes['author_url'] = normalize_url($value); } - protected function content(): Attribute + /** + * If the content contains HTML, filter it. + * + * @param string|null $value The content of the like + * @return string|null + */ + public function getContentAttribute(?string $value): ?string { - return Attribute::get( - get: function ($value, $attributes) { - if ($value === null) { - return null; - } + if ($value === null) { + return null; + } - $mf2 = Mf2\parse($value, $attributes['url']); + $mf2 = Mf2\parse($value, $this->url); - if (Arr::get($mf2, 'items.0.properties.content.0.html')) { - return $this->filterHtml( - $mf2['items'][0]['properties']['content'][0]['html'] - ); - } + if (Arr::get($mf2, 'items.0.properties.content.0.html')) { + return $this->filterHtml( + $mf2['items'][0]['properties']['content'][0]['html'] + ); + } - return $value; - } - ); + return $value; } } diff --git a/app/Models/Media.php b/app/Models/Media.php index 3d923bed..4b666d9e 100644 --- a/app/Models/Media.php +++ b/app/Models/Media.php @@ -4,7 +4,6 @@ declare(strict_types=1); namespace App\Models; -use Illuminate\Database\Eloquent\Casts\Attribute; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; @@ -14,74 +13,77 @@ class Media extends Model { use HasFactory; - /** @var string */ + /** + * The table associated with the model. + * + * @var string + */ protected $table = 'media_endpoint'; - /** @var array */ + /** + * The attributes that are mass assignable. + * + * @var array + */ protected $fillable = ['token', 'path', 'type', 'image_widths']; + /** + * Get the note that owns this media. + * + * @return BelongsTo + */ public function note(): BelongsTo { return $this->belongsTo(Note::class); } - protected function url(): Attribute + /** + * Get the URL for an S3 media file. + * + * @return string + */ + public function getUrlAttribute(): string { - return Attribute::get( - get: function ($value, $attributes) { - if (Str::startsWith($attributes['path'], 'https://')) { - return $attributes['path']; - } + if (Str::startsWith($this->path, 'https://')) { + return $this->path; + } - return config('app.url') . '/storage/' . $attributes['path']; - } - ); + return config('filesystems.disks.s3.url') . '/' . $this->path; } - protected function mediumurl(): Attribute + /** + * Get the URL for the medium size of an S3 image file. + * + * @return string + */ + public function getMediumurlAttribute(): string { - return Attribute::get( - get: fn ($value, $attributes) => $this->getSizeUrl($attributes['path'], 'medium'), - ); + $basename = $this->getBasename($this->path); + $extension = $this->getExtension($this->path); + + return config('filesystems.disks.s3.url') . '/' . $basename . '-medium.' . $extension; } - protected function smallurl(): Attribute + /** + * Get the URL for the small size of an S3 image file. + * + * @return string + */ + public function getSmallurlAttribute(): string { - return Attribute::get( - get: fn ($value, $attributes) => $this->getSizeUrl($attributes['path'], 'small'), - ); + $basename = $this->getBasename($this->path); + $extension = $this->getExtension($this->path); + + return config('filesystems.disks.s3.url') . '/' . $basename . '-small.' . $extension; } - protected function mimetype(): Attribute - { - return Attribute::get( - get: function ($value, $attributes) { - $extension = $this->getExtension($attributes['path']); - - return match ($extension) { - 'gif' => 'image/gif', - 'jpeg', 'jpg' => 'image/jpeg', - 'png' => 'image/png', - 'svg' => 'image/svg+xml', - 'tiff' => 'image/tiff', - 'webp' => 'image/webp', - 'mp4' => 'video/mp4', - 'mkv' => 'video/mkv', - default => 'application/octet-stream', - }; - }, - ); - } - - private function getSizeUrl(string $path, string $size): string - { - $basename = $this->getBasename($path); - $extension = $this->getExtension($path); - - return config('app.url') . '/storage/' . $basename . '-' . $size . '.' . $extension; - } - - private function getBasename(string $path): string + /** + * Give the real part of a filename, i.e. strip the file extension. + * + * @param string $path + * @return string + */ + public function getBasename(string $path): string { // the following achieves this data flow // foo.bar.png => ['foo', 'bar', 'png'] => ['foo', 'bar'] => foo.bar @@ -93,7 +95,13 @@ class Media extends Model }, ''), '.'); } - private function getExtension(string $path): string + /** + * Get the extension from a given filename. + * + * @param string $path + * @return string + */ + public function getExtension(string $path): string { $parts = explode('.', $path); diff --git a/app/Models/MicropubClient.php b/app/Models/MicropubClient.php index 669c7284..5a530c19 100644 --- a/app/Models/MicropubClient.php +++ b/app/Models/MicropubClient.php @@ -12,12 +12,25 @@ class MicropubClient extends Model { use HasFactory; - /** @var string */ + /** + * The table associated with the model. + * + * @var string + */ protected $table = 'clients'; - /** @var array */ + /** + * The attributes that are mass assignable. + * + * @var array + */ protected $fillable = ['client_url', 'client_name']; + /** + * Define the relationship with notes. + * + * @return HasMany + */ public function notes(): HasMany { return $this->hasMany('App\Models\Note', 'client_id', 'client_url'); diff --git a/app/Models/Note.php b/app/Models/Note.php index 74533443..b37f914c 100644 --- a/app/Models/Note.php +++ b/app/Models/Note.php @@ -4,8 +4,9 @@ declare(strict_types=1); namespace App\Models; -use App\CommonMark\Generators\MentionGenerator; -use App\CommonMark\Renderers\MentionRenderer; +use App\CommonMark\Generators\ContactMentionGenerator; +use App\CommonMark\Renderers\ContactMentionRenderer; +use App\Exceptions\TwitterContentException; use Codebird\Codebird; use Exception; use GuzzleHttp\Client; @@ -18,8 +19,8 @@ use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\MorphMany; use Illuminate\Database\Eloquent\SoftDeletes; use Illuminate\Support\Facades\Cache; +use JetBrains\PhpStorm\ArrayShape; use Jonnybarnes\IndieWeb\Numbers; -use Laravel\Scout\Searchable; use League\CommonMark\Environment\Environment; use League\CommonMark\Extension\Autolink\AutolinkExtension; use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension; @@ -35,7 +36,6 @@ use Spatie\CommonMarkHighlighter\IndentedCodeRenderer; class Note extends Model { use HasFactory; - use Searchable; use SoftDeletes; /** @@ -52,6 +52,8 @@ class Note extends Model /** * Set our contacts variable to null. + * + * @param array $attributes */ public function __construct(array $attributes = []) { @@ -59,47 +61,87 @@ class Note extends Model $this->contacts = null; } - /** @var string */ + /** + * The database table used by the model. + * + * @var string + */ protected $table = 'notes'; - /** @var array */ + /** + * Mass-assignment. + * + * @var array + */ protected $fillable = [ 'note', 'in_reply_to', 'client_id', ]; - /** @var array */ + /** + * Hide the column used with Laravel Scout. + * + * @var array + */ protected $hidden = ['searchable']; + /** + * Define the relationship with tags. + * + * @return BelongsToMany + */ public function tags(): BelongsToMany { return $this->belongsToMany(Tag::class); } + /** + * Define the relationship with clients. + * + * @return BelongsTo + */ public function client(): BelongsTo { return $this->belongsTo(MicropubClient::class, 'client_id', 'client_url'); } + /** + * Define the relationship with webmentions. + * + * @return MorphMany + */ public function webmentions(): MorphMany { return $this->morphMany(WebMention::class, 'commentable'); } + /** + * Define the relationship with places. + * + * @return BelongsTo + */ public function place(): BelongsTo { return $this->belongsTo(Place::class); } + /** + * Define the relationship with media. + * + * @return HasMany + */ public function media(): HasMany { return $this->hasMany(Media::class); } /** - * @return array + * Set the attributes to be indexed for searching with Scout. + * + * @return array */ + #[ArrayShape(['note' => 'null|string'])] public function toSearchableArray(): array { return [ @@ -107,11 +149,16 @@ class Note extends Model ]; } + /** + * Normalize the note to Unicode FORM C. + * + * @param string|null $value + */ public function setNoteAttribute(?string $value): void { if ($value !== null) { $normalized = normalizer_normalize($value, Normalizer::FORM_C); - if ($normalized === '') { // we donā€™t want to save empty strings to the db + if ($normalized === '') { //we donā€™t want to save empty strings to the db $normalized = null; } $this->attributes['note'] = $normalized; @@ -120,11 +167,14 @@ class Note extends Model /** * Pre-process notes for web-view. + * + * @param string|null $value + * @return string|null */ public function getNoteAttribute(?string $value): ?string { if ($value === null && $this->place !== null) { - $value = 'šŸ“: ' . $this->place->name . ''; + $value = 'šŸ“: ' . $this->place->name . ''; } // if $value is still null, just return null @@ -140,21 +190,23 @@ class Note extends Model /** * Provide the content_html for JSON feed. * - * In particular, we want to include media links such as images. + * In particular we want to include media links such as images. + * + * @return string */ public function getContentAttribute(): string { - $note = $this->getRawOriginal('note'); + $note = $this->note; foreach ($this->media as $media) { if ($media->type === 'image') { - $note .= PHP_EOL . ''; + $note .= ''; } if ($media->type === 'audio') { - $note .= PHP_EOL . '