Added laravel/prompts package to composer.json and updated the default disk setting in fv-sitemap.php. Created InstallCommand.php and SitemapGenerateCommand.php files in the src/Commands directory. Renamed SitemapCommand.php to SitemapGenerateCommand.php. Created SitemapController.php in the src/Http/Controllers directory. Updated SitemapServiceProvider.php to include the new commands and register the SitemapController route.

Author: thejmitchener

composer.json

@@ -18,6 +18,7 @@
     "require": {
         "php": "^8.1",
         "illuminate/contracts": "^10.0",
+        "laravel/prompts": "^0.1.16",
         "spatie/laravel-package-tools": "^1.14.0",
         "spatie/laravel-sitemap": "^7.2"
     },

config/fv-sitemap.php

@@ -3,10 +3,10 @@
 return [
     /**
      * Specifies the default filesystem disk that should be used.
-     * The 'public' disk is typically used for files that need to be publicly accessible to users.
+     * The 'public_path' disk is typically used for files that need to be publicly accessible to users.
      * This setting can influence where files, such as generated sitemaps, are stored by default.
      */
-    'disk' => 'public_path',
+    'disk' => 'public',
 
     /**
      * Determines whether the index page should be excluded from the sitemap.
@@ -24,16 +24,14 @@
      * An array of route names to be excluded from the sitemap.
      * Useful for excluding specific pages that should not be discoverable via search engines.
      */
-    'sitemap_exclude_route_names' => [
-        'welcome2',
+    'exclude_route_names' => [
     ],
 
     /**
      * Specifies paths that should be excluded from the sitemap.
      * Any routes starting with these paths will not be included in the sitemap, enhancing control over the sitemap contents.
      */
     'exclude_paths' => [
-        '/posts/',
     ],
 
     /**

resources/stubs/.gitkeep

@@ -0,0 +1,112 @@
+<?php
+
+namespace Fuelviews\Sitemap\Commands;
+
+use Illuminate\Console\Command;
+use function Laravel\Prompts\select;
+use function Laravel\Prompts\confirm;
+
+class InstallCommand extends Command
+{
+    /*
+    * TODO
+    */
+    public $signature = 'sitemap:install';
+
+    /*
+    * TODO
+    */
+    public $description = 'Sitemap install command';
+
+    /*
+     * TODO
+     */
+    public function handle(): int
+    {
+        if (confirm(
+            label:'Do you want to publish the configuration file?',
+        )) {
+            $this->call('vendor:publish', [
+                '--provider' => "Fuelviews\\Sitemap\\SitemapServiceProvider",
+                '--tag' => "config"
+            ]);
+        }
+
+        if ($frequency = select(
+            label: 'How often do you want to generate your sitemap?',
+            options: ['daily', 'weekly', 'monthly', 'never'],
+            default: 'weekly'
+        )) {
+            $this->insertSitemapGenerationCommand($frequency);
+        }
+
+        if (confirm(
+            label: 'Would you like to star our repo on GitHub?'
+        )) {
+            $this->openInBrowser('https://github.com/fuelviews/laravel-sitemap');
+        }
+
+        return self::SUCCESS;
+    }
+
+    /*
+    * TODO
+    */
+    protected function insertSitemapGenerationCommand($frequency)
+    {
+        if ($frequency === 'never') {
+            return;
+        }
+
+        $kernelPath = app_path('Console/Kernel.php');
+        $kernelContents = file_get_contents($kernelPath);
+
+        if (strpos($kernelContents, 'sitemap:generate') !== false) {
+            return;
+        }
+
+        $commandToInsert = "        \$schedule->command('sitemap:generate')->$frequency();\n";
+
+        $scheduleMethodPos = strpos($kernelContents, 'function schedule(');
+        if ($scheduleMethodPos === false) {
+            $this->error('Unable to find the schedule method in Kernel.php.');
+            return;
+        }
+
+        $insertPos = strpos($kernelContents, '//', $scheduleMethodPos);
+        if ($insertPos === false) {
+            $this->error('Unable to find the insertion point in Kernel.php.');
+            return;
+        }
+
+        $insertPos = strpos($kernelContents, "\n", $insertPos) + 1;
+        $newKernelContents = substr_replace($kernelContents, $commandToInsert, $insertPos, 0);
+
+        if (file_put_contents($kernelPath, $newKernelContents) === false) {
+            $this->error('Failed to write to Kernel.php.');
+            return;
+        }
+    }
+
+    /*
+    * TODO
+    */
+    protected function openInBrowser($url)
+    {
+        switch(PHP_OS_FAMILY) {
+            case 'Windows':
+                exec("start " . escapeshellarg($url));
+                break;
+            case 'Linux':
+                exec("xdg-open " . escapeshellarg($url));
+                break;
+            case 'Darwin': // macOS
+                exec("open " . escapeshellarg($url));
+                break;
+            default:
+                $this->error("Platform not supported.");
+                $this->info("Please visit: $url");
+                break;
+        }
+    }
+}

src/Commands/InstallCommand.php

@@ -6,15 +6,15 @@
 use GuzzleHttp\Exception\GuzzleException;
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\Config;
-use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Route;
-use Illuminate\Support\Facades\Storage;
-use Spatie\Crawler\Crawler;
+Use Illuminate\Support\Facades\Storage;
+use Illuminate\Support\Facades\Log;
 use Spatie\Sitemap\SitemapGenerator;
-use Spatie\Sitemap\SitemapIndex;
 use Spatie\Sitemap\Tags\Url;
+use Spatie\Crawler\Crawler;
+use Spatie\Sitemap\SitemapIndex;
 
-class SitemapCommand extends Command
+class SitemapGenerateCommand extends Command
 {
     /**
      * The name and signature of the console command.
@@ -31,7 +31,12 @@ class SitemapCommand extends Command
      * when listed in the console. It's shown when you run `php artisan list`
      * or when you specifically view help for this command.
      */
-    protected $description = 'Generate sitemap';
+    protected $description = 'Sitemap Generation';
+
+    /**
+     * TODO
+     */
+    protected $diskName;
 
     /**
      * Execute the console command.
@@ -44,22 +49,32 @@ class SitemapCommand extends Command
      */
     public function handle()
     {
-        $SitemapIndex = ! Config::get('fv-sitemap.exclude_index');
+        $this->diskName = Config::get('fv-sitemap.disk', 'public');
 
-        if ($SitemapIndex) {
-            $this->generatePagesSitemap();
-            $this->generatePostsSitemap();
+        try {
+            $SitemapIndex = !Config::get('fv-sitemap.exclude_index');
 
-            $sitemapIndex = SitemapIndex::create()
-                ->add('/pages_sitemap.xml')
-                ->add('/posts_sitemap.xml');
+            if ($SitemapIndex) {
+                $this->generatePagesSitemap();
+                $this->generatePostsSitemap();
 
-            $sitemapIndex->writeToFile(public_path('sitemap.xml'));
-        } else {
-            $this->generatePagesSitemap('sitemap.xml');
-        }
+                $sitemapIndex = SitemapIndex::create()
+                    ->add('/sitemap/pages_sitemap.xml')
+                    ->add('/sitemap/posts_sitemap.xml');
 
-        $this->info('Sitemap generated successfully.');
+                $sitemapIndex->writeToDisk($this->diskName, '/sitemap/sitemap.xml', true);
+            } else {
+                $this->generatePagesSitemap('/sitemap/sitemap.xml');
+            }
+
+            $this->info('Sitemap generated successfully.');
+        } catch (\Exception $e) {
+            Log::error('Sitemap generation failed: ' . $e->getMessage());
+
+            $this->error('Sitemap generation failed: ' . $e->getMessage());
+
+            return 1;
+        }
     }
 
     /**
@@ -69,14 +84,13 @@ public function handle()
      * It filters out URLs based on various criteria, including predefined excluded routes, paths,
      * and specific URLs. The resulting sitemap is then saved to a specified filename.
      *
-     * @param  string  $filename  The filename for the generated sitemap, defaulting to 'pages_sitemap.xml'.
+     * @param string $filename The filename for the generated sitemap, defaulting to 'pages_sitemap.xml'.
      */
     protected function generatePagesSitemap($filename = 'pages_sitemap.xml')
     {
-        $diskName = Config::get('fv-sitemap.disk');
-        $tempFilePath = tempnam(sys_get_temp_dir(), 'sitemap');
-
-        $excludedRouteNameUrls = $this->mapExcludedRoutesToUrls();
+        $filename = 'sitemap/' . $filename;
+        
+        $excludedRouteNameUrls = $this->mapExcludedRouteNamesToUrls();
         $excludedPaths = $this->getExcludedPaths();
         $excludedUrls = $this->getExcludedUrls();
 
@@ -100,23 +114,12 @@ protected function generatePagesSitemap($filename = 'pages_sitemap.xml')
                 $normalizedUrl = rtrim($url->url, '/');
                 if ($normalizedUrl !== $baseUrlWithoutSlash) {
                     $url->setUrl($normalizedUrl);
-                } elseif ($url->url === $baseUrlWithoutSlash.'/') {
+                } else if ($url->url === $baseUrlWithoutSlash . '/') {
                     return null;
                 }
 
                 return $url;
-            })->getSitemap()->writeToFile($tempFilePath);
-
-        $sitemapContent = file_get_contents($tempFilePath);
-
-        if ($diskName !== 'public_path') {
-            Storage::disk($diskName)->put($filename, $sitemapContent);
-        } else {
-            file_put_contents(public_path($filename), $sitemapContent);
-        }
-
-        // Remove the temporary file after use
-        @unlink($tempFilePath);
+            })->getSitemap()->writeToDisk($this->diskName, $filename, true);
     }
 
     /**
@@ -132,41 +135,74 @@ protected function generatePostsSitemap()
         //
     }
 
+    /**
+     * Determine if a path matches any of the excluded patterns.
+     *
+     * @param string $path
+     * @param array $excludedPatterns
+     * @return bool
+     */
+    protected function isPathExcluded($path, $excludedPatterns)
+    {
+        foreach ($excludedPatterns as $pattern) {
+            if (preg_match("#^" . preg_quote($pattern, '#') . "#", $path)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     /**
      * Check if a given URL is a redirect.
      *
-     * @param  string  $url
+     * @param string $url
      * @return bool
      */
     protected function isRedirect($url)
     {
         $excludeRedirects = Config::get('fv-sitemap.exclude_redirects');
 
-        if (! $excludeRedirects) {
+        if (!$excludeRedirects) {
             return false;
         }
 
         $client = new Client();
         try {
             $response = $client->request('HEAD', $url, ['allow_redirects' => false]);
             $statusCode = $response->getStatusCode();
-
             return in_array($statusCode, [301, 302, 307, 308]);
         } catch (GuzzleException $e) {
-            Log::error('Error checking URL: '.$e->getMessage());
-
+            Log::error('Error checking URL: ' . $e->getMessage());
             return false;
         }
     }
 
+    /**
+     * Map excluded route names to their URLs, excluding any that are invalid.
+     *
+     * @return array
+     */
+    protected function mapExcludedRouteNamesToUrls()
+    {
+        $excludedRouteNames = $this->getExcludedRouteNames();
+
+        return collect($excludedRouteNames)->map(function ($routeName) {
+            try {
+                return route($routeName, [], false);
+            } catch (\InvalidArgumentException $e) {
+                return null;
+            }
+        })->filter()->values()->all();
+    }
+
     /**
      * Get route names to exclude from the sitemap.
      *
      * @return array
      */
     protected function getExcludedRouteNames()
     {
-        return Config::get('fv-sitemap.sitemap_exclude_route_names', []);
+        return Config::get('fv-sitemap.exclude_route_names', []);
 
     }
 
@@ -189,40 +225,4 @@ protected function getExcludedUrls()
     {
         return Config::get('fv-sitemap.exclude_urls', []);
     }
-
-    /**
-     * Map excluded route names to their URLs, excluding any that are invalid.
-     *
-     * @return array
-     */
-    protected function mapExcludedRoutesToUrls()
-    {
-        $excludedRouteNames = $this->getExcludedRouteNames();
-
-        return collect($excludedRouteNames)->map(function ($routeName) {
-            try {
-                return route($routeName, [], false);
-            } catch (\InvalidArgumentException $e) {
-                return null;
-            }
-        })->filter()->values()->all();
-    }
-
-    /**
-     * Determine if a path matches any of the excluded patterns.
-     *
-     * @param  string  $path
-     * @param  array  $excludedPatterns
-     * @return bool
-     */
-    protected function isPathExcluded($path, $excludedPatterns)
-    {
-        foreach ($excludedPatterns as $pattern) {
-            if (preg_match('#^'.preg_quote($pattern, '#').'#', $path)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
 }