Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Transcript voice selection rework #1466

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Proposal: Transcript voice selection rework #1466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
479a083
rough implementation
eteubert May 18, 2024
73b71c0
chore: update readme
eteubert May 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions client/src/modules/transcripts/components/List.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,12 @@
<div v-else class="text-center h-96 flex items-center justify-center flex-col">
<document-text-icon class="mx-auto h-12 w-12 text-gray-400" />

<h3 class="mt-2 text-sm font-medium text-gray-900">{{ __('No transcript yet', 'podlove-podcasting-plugin-for-wordpress') }}</h3>
<p class="mt-1 text-sm text-gray-500">{{ __('Get started by importing a transcript.', 'podlove-podcasting-plugin-for-wordpress') }}</p>
<h3 class="mt-2 text-sm font-medium text-gray-900">
{{ __('No transcript yet', 'podlove-podcasting-plugin-for-wordpress') }}
</h3>
<p class="mt-1 text-sm text-gray-500">
{{ __('Get started by importing a transcript.', 'podlove-podcasting-plugin-for-wordpress') }}
</p>
<div class="mt-6">
<transcripts-import outlet="content" class="mr-1" />
</div>
Expand Down Expand Up @@ -149,6 +153,13 @@ export default defineComponent({
...transcript,
voice: get(this.voices, [transcript.voiceId], { name: transcript.voiceId }),
}))
.filter((transcript: Transcript) => {
const assignment = this.state.voices.find(
(voice: { voice: string; contributor: string }) => voice.voice == transcript.voiceId
)

return assignment.contributor != 4294967295
})
},
},

Expand Down
7 changes: 6 additions & 1 deletion client/src/modules/transcripts/components/Voices.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@
class="mt-1 block w-full py-2 px-3 border border-gray-300 bg-white rounded-md shadow-sm focus:outline-none focus:ring-indigo-500 focus:border-indigo-500 sm:text-sm"
@change="updateContributor(voice.voice, $event)"
>
<option value="0"></option>
<option value="4294967295">
[{{ __('hide from transcript', 'podlove-podcasting-plugin-for-wordpress') }}]
</option>
<option value="0">
{{ voice.voice }} ({{ __('plain text', 'podlove-podcasting-plugin-for-wordpress') }})
</option>
<option
v-for="(contributor, kindex) in sortedContributors"
:key="`voice-${vindex}-contributor-${kindex}`"
Expand Down
8 changes: 8 additions & 0 deletions lib/modules/transcripts/model/transcript.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,15 @@ public static function prepare_transcript($transcript, $mode = 'flat', $allow_em
{
$original_transcript = $transcript;

// TODO: I think this is how it should be instead.
$allow_empty_contributors = true;

$transcript = array_map(function ($t) use ($allow_empty_contributors) {
// skip hidden voices
if ($t->contributor_id === 4294967295) {
return null;
}

if (!$t->contributor_id && !$allow_empty_contributors) {
return null;
}
Expand Down
37 changes: 18 additions & 19 deletions lib/modules/transcripts/rest_api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
use Podlove\Modules\Contributors\Model\Contributor;
use Podlove\Modules\Transcripts\Model\Transcript;
use Podlove\Modules\Transcripts\Model\VoiceAssignment;
use WP_REST_Controller;
use WP_REST_Server;

class REST_API
{
Expand Down Expand Up @@ -91,7 +89,7 @@ public function permission_check()
}
}

class WP_REST_PodloveTranscripts_Controller extends WP_REST_Controller
class WP_REST_PodloveTranscripts_Controller extends \WP_REST_Controller
{
public function __construct()
{
Expand Down Expand Up @@ -124,7 +122,7 @@ public function register_routes()
'type' => 'string',
]
],
'methods' => WP_REST_Server::READABLE,
'methods' => \WP_REST_Server::READABLE,
'callback' => [$this, 'get_items'],
'permission_callback' => [$this, 'get_item_permissions_check'],
],
Expand All @@ -136,7 +134,7 @@ public function register_routes()
'required' => 'true'
]
],
'methods' => WP_REST_Server::CREATABLE,
'methods' => \WP_REST_Server::CREATABLE,
'callback' => [$this, 'create_item'],
'permission_callback' => [$this, 'create_item_permissions_check'],
],
Expand All @@ -148,12 +146,12 @@ public function register_routes()
'required' => 'true'
]
],
'methods' => WP_REST_Server::EDITABLE,
'methods' => \WP_REST_Server::EDITABLE,
'callback' => [$this, 'update_item'],
'permission_callback' => [$this, 'update_item_permissions_check'],
],
[
'methods' => WP_REST_Server::DELETABLE,
'methods' => \WP_REST_Server::DELETABLE,
'callback' => [$this, 'delete_item'],
'permission_callback' => [$this, 'delete_item_permissions_check'],
]
Expand All @@ -167,7 +165,7 @@ public function register_routes()
],
],
[
'methods' => WP_REST_Server::READABLE,
'methods' => \WP_REST_Server::READABLE,
'callback' => [$this, 'get_item_voices'],
'permission_callback' => [$this, 'get_item_permissions_check'],
],
Expand All @@ -182,7 +180,7 @@ public function register_routes()
'type' => 'integer',
]
],
'methods' => WP_REST_Server::EDITABLE,
'methods' => \WP_REST_Server::EDITABLE,
'callback' => [$this, 'update_item_voices'],
'permission_callback' => [$this, 'update_item_permissions_check'],
]
Expand Down Expand Up @@ -214,7 +212,7 @@ public function register_routes()
'type' => 'string',
]
],
'methods' => WP_REST_Server::READABLE,
'methods' => \WP_REST_Server::READABLE,
'callback' => [$this, 'get_item_transcripts'],
'permission_callback' => [$this, 'get_item_permissions_check'],
],
Expand All @@ -236,13 +234,13 @@ public function register_routes()
]
],
'description' => __('Edit a chaption of the transcript', 'podlove-podcasting-plugin-for-wordpress'),
'methods' => WP_REST_Server::EDITABLE,
'methods' => \WP_REST_Server::EDITABLE,
'callback' => [$this, 'update_item_transcripts'],
'permission_callback' => [$this, 'update_item_permissions_check'],
],
[
'description' => __('Delete a chaption of the transcript', 'podlove-podcasting-plugin-for-wordpress'),
'methods' => WP_REST_Server::DELETABLE,
'methods' => \WP_REST_Server::DELETABLE,
'callback' => [$this, 'delete_item_transcripts'],
'permission_callback' => [$this, 'delete_item_permissions_check'],
]
Expand Down Expand Up @@ -528,21 +526,22 @@ public function update_item_voices($request)
$voice_assignment = new VoiceAssignment();
$voice_assignment->episode_id = $episode->id;
$voice_assignment->voice = $voice;
$voice_assignment->contributer_id = 0;
}
}

$cid = 0;
$contributor_id = 0;

if (isset($request['contributor_id'])) {
$cid = $request['contributor_id'];
$contributor = Contributor::find_by_id($cid);
if (!$contributor) {
return new \Podlove\Api\Error\NotFound('not_found', 'Contributor is not found');
$contributor_id = $request['contributor_id'];
if ($contributor_id > 0 && $contributor_id < 4294967295) {
$contributor = Contributor::find_by_id($contributor_id);
if (!$contributor) {
return new \Podlove\Api\Error\NotFound('not_found', 'Contributor is not found');
}
}
}

$voice_assignment->contributor_id = $cid;
$voice_assignment->contributor_id = $contributor_id;
$voice_assignment->save();

return new \Podlove\Api\Response\OkResponse([
Expand Down
2 changes: 2 additions & 0 deletions readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ metadata or enabling/disabling an asset immediately clears the cache for that
feed item, resulting in the change to be visible in the RSS feed immediately.

* transcripts: contributors in voices selection are sorted alphabetically
* transcripts: voices without assigned contributors appear in transcripts
* transcripts: add dedicated option to hide a voice from a transcript

* maintenance: fix various notices from WordPress Plugin Check tool

Expand Down