feat(rss): add podcast-namespace tags for platforms + previousUrl tag (dbba8dc5) · Commits · Ad Aures / Castopod

app/Config/Routes.php

+39 −17

Original line number	Diff line number	Diff line
		@@ -32,6 +32,7 @@ $routes->setAutoRoute(false);
		$routes->addPlaceholder('podcastName', '[a-zA-Z0-9\_]{1,191}');
		$routes->addPlaceholder('slug', '[a-zA-Z0-9\-]{1,191}');
		$routes->addPlaceholder('base64', '[A-Za-z0-9\.\_]+\-{0,2}');
		$routes->addPlaceholder('platformType', '\bpodcasting\|\bsocial\|\bfunding');

		/**
		* --------------------------------------------------------------------
		@@ -69,6 +70,8 @@ $routes->add('audio/(:base64)/(:any)', 'Analytics::hit/$1/$2', [
		$routes->get('.well-known/unknown-useragents', 'UnknownUserAgents');
		$routes->get('.well-known/unknown-useragents/(:num)', 'UnknownUserAgents/$1');

		$routes->get('.well-known/platforms', 'Platform');

		// Admin area
		$routes->group(
		config('App')->adminGateway,
		@@ -94,11 +97,11 @@ $routes->group(
		$routes->post('new', 'Podcast::attemptCreate', [
		'filter' => 'permission:podcasts-create',
		]);
		$routes->get('import', 'Podcast::import', [
		$routes->get('import', 'PodcastImport', [
		'as' => 'podcast-import',
		'filter' => 'permission:podcasts-import',
		]);
		$routes->post('import', 'Podcast::attemptImport', [
		$routes->post('import', 'PodcastImport::attemptImport', [
		'filter' => 'permission:podcasts-import',
		]);

		@@ -280,25 +283,44 @@ $routes->group(
		});
		});

		$routes->group('settings', function ($routes) {
		$routes->get('/', 'PodcastSettings/$1', [
		'as' => 'podcast-settings',
		]);
		$routes->get('platforms', 'PodcastSettings::platforms/$1', [
		'as' => 'platforms',
		$routes->group('platforms', function ($routes) {
		$routes->get(
		'/',
		'PodcastPlatform::platforms/$1/podcasting',
		[
		'as' => 'platforms-podcasting',
		'filter' => 'permission:podcast-manage_platforms',
		]);
		]
		);
		$routes->get(
		'social',
		'PodcastPlatform::platforms/$1/social',
		[
		'as' => 'platforms-social',
		'filter' => 'permission:podcast-manage_platforms',
		]
		);
		$routes->get(
		'funding',
		'PodcastPlatform::platforms/$1/funding',
		[
		'as' => 'platforms-funding',
		'filter' => 'permission:podcast-manage_platforms',
		]
		);
		$routes->post(
		'platforms',
		'PodcastSettings::attemptPlatformsUpdate/$1',
		['filter' => 'permission:podcast-manage_platforms']
		'save/(:platformType)',
		'PodcastPlatform::attemptPlatformsUpdate/$1/$2',
		[
		'as' => 'platforms-save',
		'filter' => 'permission:podcast-manage_platforms',
		]
		);

		$routes->add(
		'platforms/(:num)/remove-link',
		'PodcastSettings::removePlatformLink/$1/$2',
		'(:slug)/podcast-platform-remove',
		'PodcastPlatform::removePodcastPlatform/$1/$2',
		[
		'as' => 'platforms-remove',
		'as' => 'podcast-platform-remove',
		'filter' => 'permission:podcast-manage_platforms',
		]
		);

app/Controllers/Admin/Podcast.php

+0 −228

Original line number	Diff line number	Diff line
		@@ -13,7 +13,6 @@ use App\Models\LanguageModel;
		use App\Models\PodcastModel;
		use App\Models\EpisodeModel;
		use Config\Services;
		use League\HTMLToMarkdown\HtmlConverter;

		class Podcast extends BaseController
		{
		@@ -202,233 +201,6 @@ class Podcast extends BaseController
		return redirect()->route('podcast-view', [$newPodcastId]);
		}

		public function import()
		{
		helper(['form', 'misc']);

		$languageOptions = (new LanguageModel())->getLanguageOptions();
		$categoryOptions = (new CategoryModel())->getCategoryOptions();

		$data = [
		'languageOptions' => $languageOptions,
		'categoryOptions' => $categoryOptions,
		'browserLang' => get_browser_language(
		$this->request->getServer('HTTP_ACCEPT_LANGUAGE')
		),
		];

		return view('admin/podcast/import', $data);
		}

		public function attemptImport()
		{
		helper(['media', 'misc']);

		$rules = [
		'imported_feed_url' => 'required\|validate_url',
		'season_number' => 'is_natural_no_zero\|permit_empty',
		'max_episodes' => 'is_natural_no_zero\|permit_empty',
		];

		if (!$this->validate($rules)) {
		return redirect()
		->back()
		->withInput()
		->with('errors', $this->validator->getErrors());
		}
		try {
		$feed = simplexml_load_file(
		$this->request->getPost('imported_feed_url')
		);
		} catch (\ErrorException $ex) {
		return redirect()
		->back()
		->withInput()
		->with('errors', [
		$ex->getMessage() .
		': <a href="' .
		$this->request->getPost('imported_feed_url') .
		'" rel="noreferrer noopener" target="_blank">' .
		$this->request->getPost('imported_feed_url') .
		' ⎋</a>',
		]);
		}
		$nsItunes = $feed->channel[0]->children(
		'http://www.itunes.com/dtds/podcast-1.0.dtd'
		);
		$nsPodcast = $feed->channel[0]->children(
		'https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md'
		);

		if ((string) $nsPodcast->locked === 'yes') {
		return redirect()
		->back()
		->withInput()
		->with('errors', [lang('PodcastImport.lock_import')]);
		}

		$converter = new HtmlConverter();

		$channelDescriptionHtml = $feed->channel[0]->description;

		$podcast = new \App\Entities\Podcast([
		'name' => $this->request->getPost('name'),
		'imported_feed_url' => $this->request->getPost('imported_feed_url'),
		'new_feed_url' => base_url(
		route_to('podcast_feed', $this->request->getPost('name'))
		),
		'title' => $feed->channel[0]->title,
		'description_markdown' => $converter->convert(
		$channelDescriptionHtml
		),
		'description_html' => $channelDescriptionHtml,
		'image' => download_file($nsItunes->image->attributes()),
		'language_code' => $this->request->getPost('language'),
		'category_id' => $this->request->getPost('category'),
		'parental_advisory' => empty($nsItunes->explicit)
		? null
		: (in_array($nsItunes->explicit, ['yes', 'true'])
		? 'explicit'
		: (in_array($nsItunes->explicit, ['no', 'false'])
		? 'clean'
		: null)),
		'owner_name' => $nsItunes->owner->name,
		'owner_email' => $nsItunes->owner->email,
		'publisher' => $nsItunes->author,
		'type' => empty($nsItunes->type) ? 'episodic' : $nsItunes->type,
		'copyright' => $feed->channel[0]->copyright,
		'is_blocked' => empty($nsItunes->block)
		? false
		: $nsItunes->block === 'yes',
		'is_completed' => empty($nsItunes->complete)
		? false
		: $nsItunes->complete === 'yes',
		'created_by' => user(),
		'updated_by' => user(),
		]);

		$podcastModel = new PodcastModel();
		$db = \Config\Database::connect();

		$db->transStart();

		if (!($newPodcastId = $podcastModel->insert($podcast, true))) {
		$db->transRollback();
		return redirect()
		->back()
		->withInput()
		->with('errors', $podcastModel->errors());
		}

		$authorize = Services::authorization();
		$podcastAdminGroup = $authorize->group('podcast_admin');

		$podcastModel->addPodcastContributor(
		user()->id,
		$newPodcastId,
		$podcastAdminGroup->id
		);

		$numberItems = $feed->channel[0]->item->count();
		$lastItem =
		!empty($this->request->getPost('max_episodes')) &&
		$this->request->getPost('max_episodes') < $numberItems
		? $this->request->getPost('max_episodes')
		: $numberItems;

		$slugs = [];

		// For each Episode:
		for ($itemNumber = 1; $itemNumber <= $lastItem; $itemNumber++) {
		$item = $feed->channel[0]->item[$numberItems - $itemNumber];

		$nsItunes = $item->children(
		'http://www.itunes.com/dtds/podcast-1.0.dtd'
		);

		$slug = slugify(
		$this->request->getPost('slug_field') === 'title'
		? $item->title
		: basename($item->link)
		);
		if (in_array($slug, $slugs)) {
		$slugNumber = 2;
		while (in_array($slug . '-' . $slugNumber, $slugs)) {
		$slugNumber++;
		}
		$slug = $slug . '-' . $slugNumber;
		}
		$slugs[] = $slug;

		$itemDescriptionHtml =
		$this->request->getPost('description_field') === 'summary'
		? $nsItunes->summary
		: ($this->request->getPost('description_field') ===
		'subtitle_summary'
		? $nsItunes->subtitle . '<br/>' . $nsItunes->summary
		: $item->description);

		$newEpisode = new \App\Entities\Episode([
		'podcast_id' => $newPodcastId,
		'guid' => empty($item->guid) ? null : $item->guid,
		'title' => $item->title,
		'slug' => $slug,
		'enclosure' => download_file($item->enclosure->attributes()),
		'description_markdown' => $converter->convert(
		$itemDescriptionHtml
		),
		'description_html' => $itemDescriptionHtml,
		'image' =>
		!$nsItunes->image \|\| empty($nsItunes->image->attributes())
		? null
		: download_file($nsItunes->image->attributes()),
		'parental_advisory' => empty($nsItunes->explicit)
		? null
		: (in_array($nsItunes->explicit, ['yes', 'true'])
		? 'explicit'
		: (in_array($nsItunes->explicit, ['no', 'false'])
		? 'clean'
		: null)),
		'number' =>
		$this->request->getPost('force_renumber') === 'yes'
		? $itemNumber
		: (!empty($nsItunes->episode)
		? $nsItunes->episode
		: null),
		'season_number' => empty(
		$this->request->getPost('season_number')
		)
		? (!empty($nsItunes->season)
		? $nsItunes->season
		: null)
		: $this->request->getPost('season_number'),
		'type' => empty($nsItunes->episodeType)
		? 'full'
		: $nsItunes->episodeType,
		'is_blocked' => empty($nsItunes->block)
		? false
		: $nsItunes->block === 'yes',
		'created_by' => user(),
		'updated_by' => user(),
		'published_at' => strtotime($item->pubDate),
		]);

		$episodeModel = new EpisodeModel();

		if (!$episodeModel->insert($newEpisode)) {
		// FIXME: What shall we do?
		return redirect()
		->back()
		->withInput()
		->with('errors', $episodeModel->errors());
		}
		}

		$db->transComplete();

		return redirect()->route('podcast-view', [$newPodcastId]);
		}

		public function edit()
		{
		helper('form');

app/Controllers/Admin/PodcastImport.php

0 → 100644

+307 −0

Original line number	Diff line number	Diff line
		<?php

		/**
		* @copyright 2020 Podlibre
		* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
		* @link https://castopod.org/
		*/

		namespace App\Controllers\Admin;

		use App\Models\CategoryModel;
		use App\Models\LanguageModel;
		use App\Models\PodcastModel;
		use App\Models\EpisodeModel;
		use App\Models\PlatformModel;
		use Config\Services;
		use League\HTMLToMarkdown\HtmlConverter;

		class PodcastImport extends BaseController
		{
		/**
		* @var \App\Entities\Podcast\|null
		*/
		protected $podcast;

		public function _remap($method, ...$params)
		{
		if (count($params) > 0) {
		if (
		!($this->podcast = (new PodcastModel())->getPodcastById(
		$params[0]
		))
		) {
		throw \CodeIgniter\Exceptions\PageNotFoundException::forPageNotFound();
		}
		}

		return $this->$method();
		}

		public function index()
		{
		helper(['form', 'misc']);

		$languageOptions = (new LanguageModel())->getLanguageOptions();
		$categoryOptions = (new CategoryModel())->getCategoryOptions();

		$data = [
		'languageOptions' => $languageOptions,
		'categoryOptions' => $categoryOptions,
		'browserLang' => get_browser_language(
		$this->request->getServer('HTTP_ACCEPT_LANGUAGE')
		),
		];

		return view('admin/podcast/import', $data);
		}

		public function attemptImport()
		{
		helper(['media', 'misc']);

		$rules = [
		'imported_feed_url' => 'required\|validate_url',
		'season_number' => 'is_natural_no_zero\|permit_empty',
		'max_episodes' => 'is_natural_no_zero\|permit_empty',
		];

		if (!$this->validate($rules)) {
		return redirect()
		->back()
		->withInput()
		->with('errors', $this->validator->getErrors());
		}
		try {
		$feed = simplexml_load_file(
		$this->request->getPost('imported_feed_url')
		);
		} catch (\ErrorException $ex) {
		return redirect()
		->back()
		->withInput()
		->with('errors', [
		$ex->getMessage() .
		': <a href="' .
		$this->request->getPost('imported_feed_url') .
		'" rel="noreferrer noopener" target="_blank">' .
		$this->request->getPost('imported_feed_url') .
		' ⎋</a>',
		]);
		}
		$nsItunes = $feed->channel[0]->children(
		'http://www.itunes.com/dtds/podcast-1.0.dtd'
		);
		$nsPodcast = $feed->channel[0]->children(
		'https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md'
		);

		if ((string) $nsPodcast->locked === 'yes') {
		return redirect()
		->back()
		->withInput()
		->with('errors', [lang('PodcastImport.lock_import')]);
		}

		$converter = new HtmlConverter();

		$channelDescriptionHtml = $feed->channel[0]->description;

		$podcast = new \App\Entities\Podcast([
		'name' => $this->request->getPost('name'),
		'imported_feed_url' => $this->request->getPost('imported_feed_url'),
		'new_feed_url' => base_url(
		route_to('podcast_feed', $this->request->getPost('name'))
		),
		'title' => $feed->channel[0]->title,
		'description_markdown' => $converter->convert(
		$channelDescriptionHtml
		),
		'description_html' => $channelDescriptionHtml,
		'image' => download_file($nsItunes->image->attributes()),
		'language_code' => $this->request->getPost('language'),
		'category_id' => $this->request->getPost('category'),
		'parental_advisory' => empty($nsItunes->explicit)
		? null
		: (in_array($nsItunes->explicit, ['yes', 'true'])
		? 'explicit'
		: (in_array($nsItunes->explicit, ['no', 'false'])
		? 'clean'
		: null)),
		'owner_name' => $nsItunes->owner->name,
		'owner_email' => $nsItunes->owner->email,
		'publisher' => $nsItunes->author,
		'type' => empty($nsItunes->type) ? 'episodic' : $nsItunes->type,
		'copyright' => $feed->channel[0]->copyright,
		'is_blocked' => empty($nsItunes->block)
		? false
		: $nsItunes->block === 'yes',
		'is_completed' => empty($nsItunes->complete)
		? false
		: $nsItunes->complete === 'yes',
		'created_by' => user(),
		'updated_by' => user(),
		]);

		$podcastModel = new PodcastModel();
		$db = \Config\Database::connect();

		$db->transStart();

		if (!($newPodcastId = $podcastModel->insert($podcast, true))) {
		$db->transRollback();
		return redirect()
		->back()
		->withInput()
		->with('errors', $podcastModel->errors());
		}

		$authorize = Services::authorization();
		$podcastAdminGroup = $authorize->group('podcast_admin');

		$podcastModel->addPodcastContributor(
		user()->id,
		$newPodcastId,
		$podcastAdminGroup->id
		);

		$platformModel = new PlatformModel();
		$podcastsPlatformsData = [];
		foreach ($nsPodcast->id as $podcastingPlatform) {
		$slug = $podcastingPlatform->attributes()['platform'];
		$platformModel->getOrCreatePlatform($slug, 'podcasting');
		array_push($podcastsPlatformsData, [
		'platform_slug' => $slug,
		'podcast_id' => $newPodcastId,
		'link_url' => $podcastingPlatform->attributes()['url'],
		'link_content' => $podcastingPlatform->attributes()['id'],
		'is_visible' => false,
		]);
		}
		foreach ($nsPodcast->social as $socialPlatform) {
		$slug = $socialPlatform->attributes()['platform'];
		$platformModel->getOrCreatePlatform($slug, 'social');
		array_push($podcastsPlatformsData, [
		'platform_slug' => $socialPlatform->attributes()['platform'],
		'podcast_id' => $newPodcastId,
		'link_url' => $socialPlatform->attributes()['url'],
		'link_content' => $socialPlatform,
		'is_visible' => false,
		]);
		}
		foreach ($nsPodcast->funding as $fundingPlatform) {
		$slug = $fundingPlatform->attributes()['platform'];
		$platformModel->getOrCreatePlatform($slug, 'funding');
		array_push($podcastsPlatformsData, [
		'platform_slug' => $fundingPlatform->attributes()['platform'],
		'podcast_id' => $newPodcastId,
		'link_url' => $fundingPlatform->attributes()['url'],
		'link_content' => $fundingPlatform->attributes()['id'],
		'is_visible' => false,
		]);
		}
		$platformModel->createPodcastPlatforms(
		$newPodcastId,
		$podcastsPlatformsData
		);

		$numberItems = $feed->channel[0]->item->count();
		$lastItem =
		!empty($this->request->getPost('max_episodes')) &&
		$this->request->getPost('max_episodes') < $numberItems
		? $this->request->getPost('max_episodes')
		: $numberItems;

		$slugs = [];

		// For each Episode:
		for ($itemNumber = 1; $itemNumber <= $lastItem; $itemNumber++) {
		$item = $feed->channel[0]->item[$numberItems - $itemNumber];

		$nsItunes = $item->children(
		'http://www.itunes.com/dtds/podcast-1.0.dtd'
		);

		$slug = slugify(
		$this->request->getPost('slug_field') === 'title'
		? $item->title
		: basename($item->link)
		);
		if (in_array($slug, $slugs)) {
		$slugNumber = 2;
		while (in_array($slug . '-' . $slugNumber, $slugs)) {
		$slugNumber++;
		}
		$slug = $slug . '-' . $slugNumber;
		}
		$slugs[] = $slug;

		$itemDescriptionHtml =
		$this->request->getPost('description_field') === 'summary'
		? $nsItunes->summary
		: ($this->request->getPost('description_field') ===
		'subtitle_summary'
		? $nsItunes->subtitle . '<br/>' . $nsItunes->summary
		: $item->description);

		$newEpisode = new \App\Entities\Episode([
		'podcast_id' => $newPodcastId,
		'guid' => empty($item->guid) ? null : $item->guid,
		'title' => $item->title,
		'slug' => $slug,
		'enclosure' => download_file($item->enclosure->attributes()),
		'description_markdown' => $converter->convert(
		$itemDescriptionHtml
		),
		'description_html' => $itemDescriptionHtml,
		'image' =>
		!$nsItunes->image \|\| empty($nsItunes->image->attributes())
		? null
		: download_file($nsItunes->image->attributes()),
		'parental_advisory' => empty($nsItunes->explicit)
		? null
		: (in_array($nsItunes->explicit, ['yes', 'true'])
		? 'explicit'
		: (in_array($nsItunes->explicit, ['no', 'false'])
		? 'clean'
		: null)),
		'number' =>
		$this->request->getPost('force_renumber') === 'yes'
		? $itemNumber
		: (!empty($nsItunes->episode)
		? $nsItunes->episode
		: null),
		'season_number' => empty(
		$this->request->getPost('season_number')
		)
		? (!empty($nsItunes->season)
		? $nsItunes->season
		: null)
		: $this->request->getPost('season_number'),
		'type' => empty($nsItunes->episodeType)
		? 'full'
		: $nsItunes->episodeType,
		'is_blocked' => empty($nsItunes->block)
		? false
		: $nsItunes->block === 'yes',
		'created_by' => user(),
		'updated_by' => user(),
		'published_at' => strtotime($item->pubDate),
		]);

		$episodeModel = new EpisodeModel();

		if (!$episodeModel->insert($newEpisode)) {
		// FIXME: What shall we do?
		return redirect()
		->back()
		->withInput()
		->with('errors', $episodeModel->errors());
		}
		}

		$db->transComplete();

		return redirect()->route('podcast-view', [$newPodcastId]);
		}
		}

app/Controllers/Admin/PodcastSettings.php→app/Controllers/Admin/PodcastPlatform.php

+29 −21

File changed and moved.

Preview size limit exceeded, changes collapsed.

app/Controllers/Platform.php

0 → 100644

+24 −0

Original line number	Diff line number	Diff line
		<?php

		/**
		* @copyright 2020 Podlibre
		* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
		* @link https://castopod.org/
		*/

		namespace App\Controllers;

		use CodeIgniter\Controller;

		/*
		* Provide public access to all platforms so that they can be exported
		*/
		class Platform extends Controller
		{
		public function index()
		{
		$model = new \App\Models\PlatformModel();

		return $this->response->setJSON($model->getPlatforms());
		}
		}