WIP: add playlist feature

Author: geichelberger

modules/graphql/pom.xml

@@ -168,6 +168,16 @@
       <version>${project.version}</version>
       <scope>compile</scope>
     </dependency>
+    <dependency>
+      <groupId>org.opencastproject</groupId>
+      <artifactId>opencast-playlists</artifactId>
+      <version>${project.version}</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.easymock</groupId>
+      <artifactId>easymock</artifactId>
+    </dependency>
   </dependencies>
   <build>
     <plugins>

modules/graphql/src/main/java/org/opencastproject/graphql/datafetcher/playlist/PlaylistDataFetcher.java

@@ -0,0 +1,72 @@
+/*
+ * Licensed to The Apereo Foundation under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ *
+ * The Apereo Foundation licenses this file to you under the Educational
+ * Community License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License
+ * at:
+ *
+ *   http://opensource.org/licenses/ecl2.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ */
+
+package org.opencastproject.graphql.datafetcher.playlist;
+
+import org.opencastproject.graphql.datafetcher.ContextDataFetcher;
+import org.opencastproject.graphql.exception.GraphQLRuntimeException;
+import org.opencastproject.graphql.exception.OpencastErrorType;
+import org.opencastproject.graphql.execution.context.OpencastContext;
+import org.opencastproject.graphql.playlist.GqlPlaylist;
+import org.opencastproject.playlists.Playlist;
+import org.opencastproject.playlists.PlaylistService;
+import org.opencastproject.security.api.UnauthorizedException;
+import org.opencastproject.util.NotFoundException;
+
+import java.util.Objects;
+
+import graphql.schema.DataFetchingEnvironment;
+
+public class PlaylistDataFetcher implements ContextDataFetcher<GqlPlaylist> {
+
+  private final String playlistId;
+
+  public PlaylistDataFetcher(String playlistId) {
+    Objects.requireNonNull(playlistId, "Playlist identifier must not be null.");
+    this.playlistId = playlistId;
+  }
+
+  @Override
+  public GqlPlaylist get(OpencastContext opencastContext, DataFetchingEnvironment dataFetchingEnvironment) {
+    PlaylistService playlistService = opencastContext.getService(PlaylistService.class);
+
+    try {
+      Playlist playlist = playlistService.getPlaylistById(playlistId);
+      if (playlist == null) {
+        return null;
+      }
+      // enrich if available
+      try {
+        playlist = playlistService.enrich(playlist).toPlaylist();
+      } catch (Throwable ignored) {
+        // If enrich is not available or fails, fall back to original playlist
+      }
+      return new GqlPlaylist(playlist);
+    } catch (NotFoundException e) {
+      return null;
+    } catch (UnauthorizedException e) {
+      throw new GraphQLRuntimeException("Unauthorized", OpencastErrorType.Unauthorized, e);
+    } catch (Exception e) {
+      throw new GraphQLRuntimeException("Error fetching playlist", OpencastErrorType.InternalError, e);
+    }
+  }
+}
+

modules/graphql/src/main/java/org/opencastproject/graphql/datafetcher/playlist/PlaylistOffsetDataFetcher.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed to The Apereo Foundation under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ *
+ * The Apereo Foundation licenses this file to you under the Educational
+ * Community License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License
+ * at:
+ *
+ *   http://opensource.org/licenses/ecl2.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ */
+
+package org.opencastproject.graphql.datafetcher.playlist;
+
+import org.opencastproject.graphql.datafetcher.ElasticsearchDataFetcher;
+import org.opencastproject.graphql.execution.context.OpencastContext;
+import org.opencastproject.graphql.playlist.GqlPlaylistList;
+import org.opencastproject.playlists.Playlist;
+import org.opencastproject.playlists.PlaylistService;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import graphql.schema.DataFetchingEnvironment;
+
+public class PlaylistOffsetDataFetcher extends ElasticsearchDataFetcher<GqlPlaylistList> {
+
+  @Override
+  public GqlPlaylistList get(OpencastContext opencastContext, DataFetchingEnvironment dataFetchingEnvironment) {
+    PlaylistService playlistService = opencastContext.getService(PlaylistService.class);
+
+    Integer limit = parseParam("limit", DEFAULT_PAGE_SIZE, dataFetchingEnvironment);
+    Integer offset = parseParam("offset", 0, dataFetchingEnvironment);
+
+    List<Playlist> playlists = new ArrayList<>();
+    for (Playlist p: playlistService.getPlaylists(limit, offset)) {
+      playlists.add(playlistService.enrich(p).toPlaylist());
+    }
+    return new GqlPlaylistList(playlists, limit, offset);
+  }
+
+}

modules/graphql/src/main/java/org/opencastproject/graphql/playlist/GqlEventPlaylistEntry.java

@@ -0,0 +1,63 @@
+/*
+ * Licensed to The Apereo Foundation under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ *
+ * The Apereo Foundation licenses this file to you under the Educational
+ * Community License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License
+ * at:
+ *
+ *   http://opensource.org/licenses/ecl2.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ */
+
+package org.opencastproject.graphql.playlist;
+
+import org.opencastproject.graphql.datafetcher.event.EventDataFetcher;
+import org.opencastproject.graphql.type.output.GqlPublication;
+import org.opencastproject.playlists.PlaylistEntry;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import graphql.annotations.annotationTypes.GraphQLDescription;
+import graphql.annotations.annotationTypes.GraphQLField;
+import graphql.annotations.annotationTypes.GraphQLName;
+import graphql.schema.DataFetchingEnvironment;
+
+@GraphQLName(GqlEventPlaylistEntry.TYPE_NAME)
+@GraphQLDescription("An entry in a playlist.")
+public class GqlEventPlaylistEntry implements GqlPlaylistEntry {
+
+  public static final String TYPE_NAME = "EventPlaylistEntry";
+
+  private final PlaylistEntry entry;
+
+  public GqlEventPlaylistEntry(PlaylistEntry entry) {
+    this.entry = entry;
+  }
+
+  @Override
+  public PlaylistEntry getEntry() {
+    return entry;
+  }
+
+  @GraphQLField
+  public List<GqlPublication> publication(final DataFetchingEnvironment environment) {
+    var event = new EventDataFetcher(contentId()).get(environment);
+    if (event == null) {
+      return Collections.emptyList();
+    }
+    return event.getEvent().getPublications().stream().map(GqlPublication::new).collect(Collectors.toList());
+  }
+
+}

modules/graphql/src/main/java/org/opencastproject/graphql/playlist/GqlInaccessiblePlaylistEntry.java

@@ -0,0 +1,46 @@
+/*
+ * Licensed to The Apereo Foundation under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ *
+ * The Apereo Foundation licenses this file to you under the Educational
+ * Community License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License
+ * at:
+ *
+ *   http://opensource.org/licenses/ecl2.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ */
+
+package org.opencastproject.graphql.playlist;
+
+import org.opencastproject.playlists.PlaylistEntry;
+
+import graphql.annotations.annotationTypes.GraphQLDescription;
+import graphql.annotations.annotationTypes.GraphQLName;
+
+@GraphQLName(GqlInaccessiblePlaylistEntry.TYPE_NAME)
+@GraphQLDescription("An entry in a playlist.")
+public class GqlInaccessiblePlaylistEntry implements GqlPlaylistEntry {
+
+  public static final String TYPE_NAME = "InaccessiblePlaylistEntry";
+
+  private final PlaylistEntry entry;
+
+  public GqlInaccessiblePlaylistEntry(PlaylistEntry entry) {
+    this.entry = entry;
+  }
+
+  @Override
+  public PlaylistEntry getEntry() {
+    return entry;
+  }
+
+}

modules/graphql/src/main/java/org/opencastproject/graphql/playlist/GqlPlaylist.java

@@ -0,0 +1,108 @@
+/*
+ * Licensed to The Apereo Foundation under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ *
+ * The Apereo Foundation licenses this file to you under the Educational
+ * Community License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License
+ * at:
+ *
+ *   http://opensource.org/licenses/ecl2.txt
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ */
+
+package org.opencastproject.graphql.playlist;
+
+import org.opencastproject.graphql.type.DateTimeFunction;
+import org.opencastproject.playlists.Playlist;
+import org.opencastproject.playlists.PlaylistAccessControlEntry;
+import org.opencastproject.playlists.PlaylistEntry;
+
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import graphql.annotations.annotationTypes.GraphQLDescription;
+import graphql.annotations.annotationTypes.GraphQLField;
+import graphql.annotations.annotationTypes.GraphQLID;
+import graphql.annotations.annotationTypes.GraphQLName;
+import graphql.annotations.annotationTypes.GraphQLNonNull;
+import graphql.annotations.annotationTypes.GraphQLType;
+
+@GraphQLName(GqlPlaylist.TYPE_NAME)
+@GraphQLDescription("A playlist of events.")
+public class GqlPlaylist {
+
+  public static final String TYPE_NAME = "Playlist";
+
+  private final Playlist playlist;
+
+  public GqlPlaylist(Playlist playlist) {
+    this.playlist = playlist;
+  }
+
+  @GraphQLID
+  @GraphQLField
+  @GraphQLNonNull
+  public String id() {
+    return playlist.getId();
+  }
+
+  @GraphQLField
+  public LinkedList<GqlPlaylistEntry> entries() {
+    List<PlaylistEntry> entries = playlist.getEntries();
+    if (entries == null) {
+      return new LinkedList<>();
+    }
+    return entries.stream().map(e -> switch (e.getType()) {
+      case EVENT -> new GqlEventPlaylistEntry(e);
+      case INACCESSIBLE -> new GqlInaccessiblePlaylistEntry(e);
+    }).collect(Collectors.toCollection(LinkedList::new));
+  }
+
+  @GraphQLField
+  public String title() {
+    return playlist.getTitle();
+  }
+
+  @GraphQLField
+  public String description() {
+    return playlist.getDescription();
+  }
+
+  @GraphQLField
+  public String creator() {
+    return playlist.getCreator();
+  }
+
+  @GraphQLField
+  @GraphQLType(DateTimeFunction.class)
+  public OffsetDateTime updated() {
+    return playlist.getUpdated().toInstant().atOffset(ZoneOffset.UTC);
+  }
+
+  @GraphQLField
+  public LinkedList<GqlPlaylistAccessControlEntry> accessControlEntries() {
+    List<PlaylistAccessControlEntry> aces = playlist.getAccessControlEntries();
+    if (aces == null) {
+      return new LinkedList<>();
+    }
+    return aces.stream().map(GqlPlaylistAccessControlEntry::new)
+        .collect(Collectors.toCollection(LinkedList::new));
+  }
+
+  public Playlist getPlaylist() {
+    return playlist;
+  }
+
+}