BigBlueButton/bigbluebutton-Github
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3388 from jfederico/extension_preview_for_thumbnails_on_recordings

Browse Source 
Extension preview for thumbnails on recordings
This commit is contained in:
Fred Dixon 2016-09-30 17:17:48 -04:00 committed by GitHub
commit ce4ef05c21
10 changed files with 281 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bigbluebutton-web/grails-app/controllers/org/bigbluebutton/web/controllers/ApiController.groovy
View File

@ -865,6 +865,7 @@ class ApiController {
for (m in mtgs) {
meeting {
meetingID() { mkp.yield(m.getExternalId()) }
internalMeetingID() { mkp.yield(m.getInternalId()) }
isBreakout() { mkp.yield(m.isBreakout()) }
meetingName() { mkp.yield(m.getName()) }
createTime(m.getCreateTime())
@ -2192,6 +2193,7 @@ class ApiController {
response() {
returncode(RESP_CODE_SUCCESS)
meetingID() { mkp.yield(meeting.getExternalId()) }
internalMeetingID() { mkp.yield(meeting.getInternalId()) }
attendeePW() { mkp.yield(meeting.getViewerPassword()) }
moderatorPW() { mkp.yield(meeting.getModeratorPassword()) }
createTime(meeting.getCreateTime())

135
bigbluebutton-web/src/groovy/org/bigbluebutton/api/RecordingServiceHelperImp.groovy
View File

@ -19,12 +19,18 @@
package org.bigbluebutton.api;
import groovy.json.JsonBuilder;
import groovy.util.XmlSlurper;
import groovy.util.slurpersupport.Attributes;
import groovy.util.slurpersupport.GPathResult;
import groovy.xml.MarkupBuilder;
import java.io.File;
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.List;
import org.bigbluebutton.api.domain.Extension;
import org.bigbluebutton.api.domain.Recording;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@ -44,7 +50,15 @@ public class RecordingServiceHelperImp implements RecordingServiceHelper {
<processing_time>5429</processing_time>
<duration>101014</duration>
<extension>
... Any XML element, to be passed through into playback format element.
<!-- Any XML element, to be passed through into playback format element. -->
<preview> <!-- The first level is the name of the extension -->
<text>Instrument Flying</text>
<images>
<image width="176" height="136" alt="Instrument Flying">http://bbb-server/.../thumb-1.png</image>
<image width="176" height="136" alt="Course Structure">http://bbb-server/.../thumb-2.png</image>
<image width="176" height="136" alt="Requirements">http://bbb-server/.../thumb-3.png</image>
</images>
</preview>
</extension>
</playback>
<meta>
@ -59,7 +73,7 @@ public class RecordingServiceHelperImp implements RecordingServiceHelper {
public void writeRecordingInfo(String path, Recording info) {
def writer = new StringWriter()
def builder = new groovy.xml.MarkupBuilder(writer)
def metadataXml = builder.recording {
builder.recording {
builder.id(info.getId())
builder.state(info.getState())
builder.published(info.isPublished())
@ -72,7 +86,17 @@ public class RecordingServiceHelperImp implements RecordingServiceHelper {
builder.format(info.getPlaybackFormat())
builder.link(info.getPlaybackLink())
builder.duration(info.getPlaybackDuration())
builder.extension(info.getPlaybackExtensions())
def extensions = info.getPlaybackExtensions()
if ( !extensions.isEmpty() ) {
builder.extensions {
extensions.each { extension ->
def extensionType = extension.getType()
builder."${extensionType}"{
extensionPropertiesToXML(builder, extension.getProperties())
}
}
}
}
}
}
Map<String,String> metainfo = info.getMetadata();
@ -92,7 +116,7 @@ public class RecordingServiceHelperImp implements RecordingServiceHelper {
File file = new File(dir.getPath() + File.separatorChar + "metadata.xml");
if ( file ) {
def recording = new XmlSlurper().parse(file);
return getInfo(recording);
return getInfo(recording);
}
} catch ( FileNotFoundException e) {
// Do nothing, just return null
@ -105,6 +129,7 @@ public class RecordingServiceHelperImp implements RecordingServiceHelper {
private Recording getInfo(GPathResult rec) {
Recording r = new Recording();
//Add basic information
r.setId(rec.id.text());
r.setState(rec.state.text());
r.setPublished(Boolean.parseBoolean(rec.published.text()));
@ -116,11 +141,14 @@ public class RecordingServiceHelperImp implements RecordingServiceHelper {
r.setPlaybackDuration(rec.playback.duration.text());
}
/*
Commenting this out to see if this is causing memory to hang around resulting in
OOM in tomcat7 (ralam july 23, 2015)
r.setPlaybackExtensions(rec.playback.extension.children());
*/
//Add extensions
List<Extension> extensions = new ArrayList<Extension>()
rec.playback.extensions.children().each { extension ->
extensions.add( new Extension(extension.name(), extensionPropertiesToMap(extension)) )
}
r.setPlaybackExtensions(extensions)
//Add metadata
Map<String, String> meta = new HashMap<String, String>();
rec.meta.children().each { anode ->
meta.put(anode.name().toString(), anode.text().toString());
@ -129,4 +157,93 @@ public class RecordingServiceHelperImp implements RecordingServiceHelper {
return r;
}
private Map<String, ?> processNode( Map<String, ?> map, node) {
if ( !map[node.name()] ) {
map[node.name()] = map.getClass().newInstance()
}
Map<String, ?> nodeMap = map[node.name()]
node.children().each { it ->
if (it.children().size() == 0) {
processLeaf( nodeMap, it)
} else {
processNode( nodeMap, it)
}
}
nodeMap
}
private Map<String, ?> processLeaf(Map<String, ?> map, node) {
//Initialize map for node content
Map<String, ?> nodeContent = [ : ]
//Assign node content text
nodeContent["text"] = node.text()
//Assign node content attributes (if any)
Map attributes = node.attributes()
if( attributes.size() > 0 ) {
nodeContent["attributes"] = [ : ]
attributes.each { attribute ->
nodeContent["attributes"][attribute.getKey()] = attribute.getValue()
}
}
//Add content to the node
if ( map[node.name()] == null ) {
map[node.name()] = nodeContent
} else {
if ( ! (map[node.name()] instanceof List) ) {
map[node.name()] = [ map[node.name()] ]
}
map[node.name()] << nodeContent
}
map
}
private Map<String, ?> extensionPropertiesToMap(GPathResult xml) {
Map<String, ?> map = [ : ]
xml.children().each {
if ( it.children().size() == 0 ) {
processLeaf(map, it)
} else {
processNode(map, it)
}
}
map
}
private void processMap(builder, node) {
node.each { key, value ->
if ( value instanceof Collection ) {
processCollection(builder, key, value)
} else if ( value instanceof Map ) {
if ( value.containsKey("text") && value.containsKey("attributes") ) {
builder."${key}"(value["attributes"], value["text"])
} else {
builder."${key}" {
processMap(builder, value)
}
}
} else {
builder."${key}"(value)
}
}
}
private void processCollection(builder, nodesKey, nodes) {
nodes.each { node ->
processMap(builder, [ "${nodesKey}" : node ])
}
}
private void extensionPropertiesToXML(builder, properties) {
properties.each { propertyKey, propertyValue ->
if ( propertyValue instanceof Collection ) {
builder."${propertyKey}" {
processCollection(builder, propertyKey, propertyValue)
}
} else {
builder."${propertyKey}" {
processMap(builder, propertyValue)
}
}
}
}
}

23
bigbluebutton-web/src/java/org/bigbluebutton/api/MeetingService.java
View File

@ -401,10 +401,8 @@ public class MeetingService implements MessageListener {
return null;
}
public Map<String, Recording> getRecordings(List<String> idList,
List<String> states) {
List<Recording> recsList = recordingService.getRecordings(idList,
states);
public Map<String, Recording> getRecordings(List<String> idList, List<String> states) {
List<Recording> recsList = recordingService.getRecordings(idList, states);
Map<String, Recording> recs = reorderRecordings(recsList);
return recs;
}
@ -412,8 +410,7 @@ public class MeetingService implements MessageListener {
public Map<String, Recording> filterRecordingsByMetadata(
Map<String, Recording> recordings,
Map<String, String> metadataFilters) {
return recordingService.filterRecordingsByMetadata(recordings,
metadataFilters);
return recordingService.filterRecordingsByMetadata(recordings, metadataFilters);
}
public Map<String, Recording> reorderRecordings(List<Recording> olds) {
@ -430,9 +427,8 @@ public class MeetingService implements MessageListener {
List<Playback> plays = new ArrayList<Playback>();
if (r.getPlaybackFormat() != null) {
plays.add(new Playback(r.getPlaybackFormat(), r
.getPlaybackLink(), getDurationRecording(
r.getPlaybackDuration(), r.getEndTime(),
plays.add(new Playback(r.getPlaybackFormat(), r.getPlaybackLink(),
getDurationRecording(r.getPlaybackDuration(), r.getEndTime(),
r.getStartTime()), r.getPlaybackExtensions()));
}
@ -440,12 +436,9 @@ public class MeetingService implements MessageListener {
map.put(r.getId(), r);
} else {
Recording rec = map.get(r.getId());
rec.getPlaybacks().add(
new Playback(r.getPlaybackFormat(),
r.getPlaybackLink(), getDurationRecording(
r.getPlaybackDuration(),
r.getEndTime(), r.getStartTime()), r
.getPlaybackExtensions()));
rec.getPlaybacks().add(new Playback(r.getPlaybackFormat(), r.getPlaybackLink(),
getDurationRecording(r.getPlaybackDuration(), r.getEndTime(),
r.getStartTime()), r.getPlaybackExtensions()));
}
}

44
bigbluebutton-web/src/java/org/bigbluebutton/api/domain/Extension.java Normal file
View File

@ -0,0 +1,44 @@
/**
* BigBlueButton open source conferencing system - http://www.bigbluebutton.org/
*
* Copyright (c) 2012 BigBlueButton Inc. and by respective authors (see below).
*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free Software
* Foundation; either version 3.0 of the License, or (at your option) any later
* version.
*
* BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along
* with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
*
*/
package org.bigbluebutton.api.domain;
import java.util.Map;
public class Extension {
private String type;
private Map<String,Object> properties;
public Extension(String type, Map<String,Object> properties) {
this.type = type;
this.properties = properties;
}
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public Map<String,Object> getProperties() {
return properties;
}
public void setProperties(Map<String,Object> properties) {
this.properties = properties;
}
}

12
bigbluebutton-web/src/java/org/bigbluebutton/api/domain/Playback.java
View File

@ -18,15 +18,16 @@
*/
package org.bigbluebutton.api.domain;
import groovy.util.slurpersupport.GPathResult;
import java.util.List;
public class Playback {
private String format;
private String url;
private int length;
private GPathResult extensions;
private List<Extension> extensions;
public Playback(String format, String url, int length, GPathResult extensions) {
public Playback(String format, String url, int length, List<Extension> extensions) {
this.format = format;
this.url = url;
this.length = length;
@ -50,11 +51,10 @@ public class Playback {
public void setLength(int length) {
this.length = length;
}
public GPathResult getExtensions() {
public List<Extension> getExtensions() {
return extensions;
}
public void setExtensions(GPathResult extensions) {
public void setExtensions(List<Extension> extensions) {
this.extensions = extensions;
}
}

24
bigbluebutton-web/src/java/org/bigbluebutton/api/domain/Recording.java
View File

@ -27,8 +27,6 @@ import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import groovy.util.slurpersupport.GPathResult;
public class Recording {
private String id;
private String meetingID;
@ -44,16 +42,16 @@ public class Recording {
private String playbackLink;
private String playbackFormat;
private String playbackDuration;
private GPathResult playbackExtensions;
private List<Extension> playbackExtensions;
public static final String STATE_PROCESSING = "processing";
public static final String STATE_PROCESSED = "processed";
public static final String STATE_PUBLISING = "publishing";
public static final String STATE_PUBLISHED = "published";
public static final String STATE_UNPUBLISING = "unpublishing";
public static final String STATE_UNPUBLISHED = "unpublished";
public static final String STATE_DELETING = "deleting";
public static final String STATE_DELETED = "deleted";
public static final String STATE_PROCESSING = "processing";
public static final String STATE_PROCESSED = "processed";
public static final String STATE_PUBLISING = "publishing";
public static final String STATE_PUBLISHED = "published";
public static final String STATE_UNPUBLISING = "unpublishing";
public static final String STATE_UNPUBLISHED = "unpublished";
public static final String STATE_DELETING = "deleting";
public static final String STATE_DELETED = "deleted";
public String getId() {
return id;
@ -123,11 +121,11 @@ public class Recording {
this.playbackDuration = playbackDuration;
}
public GPathResult getPlaybackExtensions() {
public List<Extension> getPlaybackExtensions() {
return playbackExtensions;
}
public void setPlaybackExtensions(GPathResult playbackExtensions) {
public void setPlaybackExtensions(List<Extension> playbackExtensions) {
this.playbackExtensions = playbackExtensions;
}

26
bigbluebutton-web/web-app/WEB-INF/freemarker/get-recordings.ftl
View File

@ -28,7 +28,31 @@
<type>${p.getFormat()}</type>
<url>${p.getUrl()}</url>
<length>${p.getLength()}</length>
<#-- Missing p.getExtensions() -->
<#if p.getExtensions()??>
<#list p.getExtensions() as extension>
<${extension.getType()}>
<#assign properties = extension.getProperties()>
<#if extension.getType() == "preview">
<#list properties?keys as property>
<#if property == "images">
<${property}>
<#if properties[property]["image"]?? && properties[property]["image"]?is_hash>
<#assign image = properties[property]["image"]>
<image <#if image["attributes"]?? && image["attributes"]["width"]??>width="${image["attributes"]["width"]}"</#if> <#if image["attributes"]?? && image["attributes"]["height"]??>height="${image["attributes"]["height"]}"</#if> <#if image["attributes"]?? && image["attributes"]["alt"]??>alt="${image["attributes"]["alt"]}"</#if>>${image["text"]}</image>
<#elseif properties[property]["image"]?is_enumerable>
<#list properties[property]["image"] as image>
<image <#if image["attributes"]?? && image["attributes"]["width"]??>width="${image["attributes"]["width"]}"</#if> <#if image["attributes"]?? && image["attributes"]["height"]??>height="${image["attributes"]["height"]}"</#if> <#if image["attributes"]?? && image["attributes"]["alt"]??>alt="${image["attributes"]["alt"]}"</#if>>${image["text"]}</image>
</#list>
</#if>
</${property}>
<#else>
<${property} />
</#if>
</#list>
</#if>
</${extension.getType()}>
</#list>
</#if>
</format>
</#if>
</#list>

47
record-and-playback/core/lib/recordandplayback/generators/presentation.rb
View File

@ -67,12 +67,51 @@ module BigBlueButton
self.extract_png_page_from_pdf(1, pdf_page, png_out, '800x600')
end
#Convert an image to a png
# Convert an image to a png
def self.convert_image_to_png(image, png_image, resize = '800x600')
BigBlueButton.logger.info("Task: Converting image to .png")
command = "convert #{image} -resize #{resize} -background white -flatten #{png_image}"
BigBlueButton.execute(command)
BigBlueButton.logger.info("Task: Converting image to .png")
command = "convert #{image} -resize #{resize} -background white -flatten #{png_image}"
BigBlueButton.execute(command)
end
# Gathers the text from the slide
def self.get_text_from_slide(textfiles_dir, slide_num)
text_from_slide = nil
if File.file?("#{textfiles_dir}/slide-#{slide_num}.txt")
text_from_slide = File.open("#{textfiles_dir}/slide-#{slide_num}.txt") {|f| f.readline}
unless text_from_slide == nil
text_from_slide = text_from_slide.strip
end
end
text_from_slide
end
# Get from events the presentation that will be used for preview.
def self.get_presentation_for_preview(process_dir)
events_xml = "#{process_dir}/events.xml"
BigBlueButton.logger.info("Task: Getting from events the presentation to be used for preview")
presentation = {}
doc = Nokogiri::XML(File.open(events_xml))
doc.xpath("//event[@eventname='SharePresentationEvent']").each do |presentation_event|
# Extract presentation data from events
presentation_id = presentation_event.xpath("presentationName").text
presentation_filename = presentation_event.xpath("originalFilename").text
# Set textfile directory
textfiles_dir = "#{process_dir}/presentation/#{presentation_id}/textfiles"
# Set presentation hashmap to be returned
presentation[:id] = presentation_id
presentation[:filename] = presentation_filename
presentation[:slides] = {}
presentation[:slides][1] = { :alt => self.get_text_from_slide(textfiles_dir, 1) }
unless presentation_filename == "default.pdf"
presentation[:slides][2] = { :alt => self.get_text_from_slide(textfiles_dir, 2) } if File.file?("#{textfiles_dir}/slide-2.txt")
presentation[:slides][3] = { :alt => self.get_text_from_slide(textfiles_dir, 3) } if File.file?("#{textfiles_dir}/slide-3.txt")
# Break because something else than default.pdf was found
break
end
end
presentation
end
end
end

3
record-and-playback/presentation/scripts/process/presentation.rb
View File

@ -165,6 +165,9 @@ if not FileTest.directory?(target_dir)
command="convert #{images[0]} -resize 1600x1200 -background white -flatten #{target_pres_dir}/slide-1.png"
BigBlueButton.execute(command)
end
# Copy thumbnails from raw files
FileUtils.cp_r("#{pres_dir}/thumbnails", "#{target_pres_dir}/thumbnails")
end
BigBlueButton.logger.info("Generating closed captions")

13
record-and-playback/presentation/scripts/publish/presentation.rb
View File

@ -1022,12 +1022,25 @@ begin
playback.remove
end
## Add the actual playback
presentation = BigBlueButton::Presentation.get_presentation_for_preview("#{$process_dir}")
metadata_with_playback = Nokogiri::XML::Builder.with(metadata.at('recording')) do |xml|
xml.playback {
xml.format("presentation")
xml.link("#{playback_protocol}://#{playback_host}/playback/presentation/0.9.0/playback.html?meetingId=#{$meeting_id}")
xml.processing_time("#{processing_time}")
xml.duration("#{recording_time}")
unless presentation.empty?
xml.extensions {
xml.preview {
xml.images {
presentation[:slides].each do |key,val|
attributes = {:width => "176", :height => "136", :alt => (val[:alt] != nil)? "#{val[:alt]}": ""}
xml.image(attributes){ xml.text("#{playback_protocol}://#{playback_host}/presentation/#{$meeting_id}/presentation/#{presentation[:id]}/thumbnails/thumb-#{key}.png") }
end
}
}
}
end
}
end
## Write the new metadata.xml