Plugin: SJQv4

[wayner]

It looks great - I love the animated dropdown menus, and it is great to be able to get SJQ info via the web. How do I inject my own menu items?

[wayner]

I updated SJQ and now I have a script failing from SJQ - however this script runs fine from the SageGroovyConsole. Perhaps something in the new version of Groovy is causing the problem as I assume that the SageGroovyConsole has not been updated.The script attempts to send an email with today's recordings. Here is the error:

===== Mon Oct 22 00:25:26 EDT 2012 =====

LOG4J: Configured Logging for: sagex-api using file: sagex-api.log4j.properties
----- error  -----

javax.script.ScriptException: org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
Script1.groovy: 27: The class 'EmailSettings' has an incorrect modifier private.
 @ line 27, column 1.
   private class EmailSettings {
   ^

1 error

	at org.codehaus.groovy.jsr223.GroovyScriptEngineImpl.eval(GroovyScriptEngineImpl.java:138)
	at org.codehaus.groovy.jsr223.GroovyScriptEngineImpl.eval(GroovyScriptEngineImpl.java:124)
	at com.google.code.sagetvaddons.sjq.agent.ScriptRunner.exec(ScriptRunner.java:114)
	at com.google.code.sagetvaddons.sjq.agent.ScriptRunner.main(ScriptRunner.java:175)
Caused by: org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
Script1.groovy: 27: The class 'EmailSettings' has an incorrect modifier private.
 @ line 27, column 1.
   private class EmailSettings {
   ^

1 error

	at org.codehaus.groovy.control.ErrorCollector.failIfErrors(ErrorCollector.java:309)
	at org.codehaus.groovy.control.CompilationUnit.applyToPrimaryClassNodes(CompilationUnit.java:1054)
	at org.codehaus.groovy.control.CompilationUnit.doPhaseOperation(CompilationUnit.java:564)
	at org.codehaus.groovy.control.CompilationUnit.processPhaseOperations(CompilationUnit.java:542)
	at org.codehaus.groovy.control.CompilationUnit.compile(CompilationUnit.java:519)
	at groovy.lang.GroovyClassLoader.doParseClass(GroovyClassLoader.java:279)
	at groovy.lang.GroovyClassLoader.parseClass(GroovyClassLoader.java:258)
	at groovy.lang.GroovyClassLoader.parseClass(GroovyClassLoader.java:244)
	at groovy.lang.GroovyClassLoader.parseClass(GroovyClassLoader.java:202)
	at org.codehaus.groovy.jsr223.GroovyScriptEngineImpl.getScriptClass(GroovyScriptEngineImpl.java:354)
	at org.codehaus.groovy.jsr223.GroovyScriptEngineImpl.eval(GroovyScriptEngineImpl.java:130)
	... 3 more
------------------




==============================

The relevant code in my script looks like this (I probably stole this from one of your scripts):

private class EmailSettings {
    static def sendMail = true                  // Set this to false to just dump the alert msg to stdout instead of emailing it
    static def host = 'smtp.gmail.com'
    static def user = 'wayner@gmail.com'
    static def pwd  = '****'
    static def port = '465'
    static def subj = 'Sage Recordings for Today'
    static def from = user                       // Gmail will reject mail via SMTP if the from addr != user id so no point in changing this
    static def to   = 'wayner@gmail.com'           // Sometimes Gmail won't send an email addressed to yourself, try a plus address at the end; YMMV
    static def ssl  = 'true'                     // Gmail requires SSL, other SMTP servers may or may not; this is a STRING setting!

}

def sendMail(def msg) {
   def ant = new AntBuilder()
   ant.mail(mailhost: EmailSettings.host, mailport: EmailSettings.port, subject: EmailSettings.subj, user: EmailSettings.user, password: EmailSettings.pwd, ssl: "true") {
       from(address: EmailSettings.from)
       to(address: EmailSettings.to)
       message(msg)   
   }
}

[Slugger]

Originally Posted by wayner

I updated SJQ and now I have a script failing from SJQ - however this script runs fine from the SageGroovyConsole. Perhaps something in the new version of Groovy is causing the problem as I assume that the SageGroovyConsole has not been updated.

Yup, I touched on this a few posts back, but Groovy 2.0 does not allow the use of private fields, methods, nor classes in top level scripts. The fix is as simple as removing the private key word from the class definition.

[Slugger]

Originally Posted by wayner

It looks great - I love the animated dropdown menus, and it is great to be able to get SJQ info via the web. How do I inject my own menu items?

Details on how to inject additional items can be found here:

https://code.google.com/p/sagetv-add...sIntoWebUIMenu

Beware of the bug I describe at the bottom of that page. Just discovered that now while writing that doc. Basically, only injections of new top level menus currently works, the mechanism described to inject items into existing menus does not work. I'm in no hurry to go fixing that bug unless enough people express the desire to actually use the functionality.

[Slugger]

A new build of SageGroovy has been uploaded to Google Code that upgrades Groovy to 2.0.5.

[wayner]

I know we are getting into a lot of Sage Web server discussion in the SJQ thread, but one thing that should really be added to the Sage Web home page is the Java Heap status - there is a bunch of other status type of info but for some reason this is missing.

[wayner]

Originally Posted by Slugger

Details on how to inject additional items can be found here:

Great, thanks Slugger. If users come up with a bunch of useful additional items would it be possible to bundle these into the core product? Two things that I would like to add to the system are the ability to restart the SageTVService, and a Client/Extender status report.

[Slugger]

Originally Posted by wayner

I know we are getting into a lot of Sage Web server discussion in the SJQ thread, but one thing that should really be added to the Sage Web home page is the Java Heap status - there is a bunch of other status type of info but for some reason this is missing.

I happily accept patches. Provide a patch and I'll happily build it and upload it to the repository.

Originally Posted by wayner

Great, thanks Slugger. If users come up with a bunch of useful additional items would it be possible to bundle these into the core product? Two things that I would like to add to the system are the ability to restart the SageTVService, and a Client/Extender status report.

Sure. But there's nothing stopping you from simply creating a new plugin whose only file is the web.menu file to be injected into the menu. But I'd also accept a patch that updates the base menu as well.

And now we are way off topic here, please take any follow ups from this over to the web UI thread. Thanks.

[wayner]

To get back to SJQ - would it be possible to add other events that would trigger SJQ tasks. Items like Client/Context connected/disconnected, SageTV service start, etc. The SageAlert list of Events would even be a good starting point.

I guess I could trigger a Process Executor from SageAlert that kicks off a Groovy script, but it would likely be cleaner to do everything within SJQ.

[razrsharpe]

Originally Posted by wayner

For example it would be nice to at least provide a link in the web server menus to the SJQ groovy page that allows you to manage SJQ via the web server.

Originally Posted by Slugger

An SJQ Web UI update should be in the repo shortly that injects the SJQ menu into the web UI.

When did SJQ v4 get a web ui? and what can be done with it? I tried searching for some info about it but couldn't find anything. (If i missed where that is can someone point me in the right direction? )

One of the major things still preventing me from upgrading to SJQ v4 is the lack of a web ui... Sounds like i might need to carve out an evening or 2 to upgrade...

[wayner]

I imagine Slugger will chime in on this, but here is my recollection...

About a year or more ago Slugger added the capability to use Groovy scripts to develop your own Sage web pages. I believe he did this to facilitate addin a web UI to SJQv4, amont other things, and he created the SJQ code for it at that time but it was kind of undocumented and hidden away although if you knew the path you could get to it. Due to the declining interest in Sage, and his lack of time he kind of stepped back from enhancing these plugins.

You can use it to browse the Queue, browse clients, enter all of the arguments for a task, I think pretty much everything you could do in the previous versions of SJQ. And now you can write tasks that can be linked to web pages - like just hitting a web page to cause a restart of your Sage service.

[Slugger]

Originally Posted by wayner

To get back to SJQ - would it be possible to add other events that would trigger SJQ tasks. Items like Client/Context connected/disconnected, SageTV service start, etc. The SageAlert list of Events would even be a good starting point.

SA event list is a good starting point? The SA event list is basically every Sage event. lol!! (Might be missing a couple.)

Is it possible? Yes. Is it likely... hmmmmm... probably not. There is only exactly one plugin that I'm actively developing: Schedules Direct EPG plugin. Everything else is maintenance only, and by "maintenance" I basically mean dormant. Features like this basically would only happen if I wanted/needed it in my environment. This, unfortunately, doesn't qualify.

The various updates and builds of other things over the weekend only happened because I need/want to upgrade to Groovy 2.0 for the EPG plugin. The initial web server build was a necessity to fix the Groovy support in the web ui that Groovy 2.0 would have broken with no update. The other couple builds were a bonus because I already had the code open, wanted the plugin manager fix and since you asked nicely I threw in the new menu as well (which, I'll admit, is also something I certainly didn't mind having). Even that didn't get released bug free (can't inject into existing menus as planned). But I have no desire to do another build just to fix that - until I actually want to inject into existing menus (or there's an overwhelming cry from the masses to fix it).

I guess I could trigger a Process Executor from SageAlert that kicks off a Groovy script, but it would likely be cleaner to do everything within SJQ.

And that Groovy script could then inject tasks into your SJQ queue. A really small groovy script is all you'd need to simply throw an arbitrary task into the SJQ task queue. You can then do all the heavy lifting via SJQ once you get that task in there. If I really wanted to trigger SJQ tasks on unsupported events and I didn't own the code, this is how I'd do it.

And, as always, I gladly accept and will build user supplied patches.

[Slugger]

Originally Posted by razrsharpe

When did SJQ v4 get a web ui? and what can be done with it? I tried searching for some info about it but couldn't find anything. (If i missed where that is can someone point me in the right direction? )

One of the major things still preventing me from upgrading to SJQ v4 is the lack of a web ui... Sounds like i might need to carve out an evening or 2 to upgrade...

Originally Posted by wayner

I imagine Slugger will chime in on this, but here is my recollection...

About a year or more ago Slugger added the capability to use Groovy scripts to develop your own Sage web pages. I believe he did this to facilitate addin a web UI to SJQv4, amont other things, and he created the SJQ code for it at that time but it was kind of undocumented and hidden away although if you knew the path you could get to it. Due to the declining interest in Sage, and his lack of time he kind of stepped back from enhancing these plugins.

You can use it to browse the Queue, browse clients, enter all of the arguments for a task, I think pretty much everything you could do in the previous versions of SJQ. And now you can write tasks that can be linked to web pages - like just hitting a web page to cause a restart of your Sage service.

Pretty much what Wayne said. I wrote the web UI support back in January, I announced it somewhere in here, but didn't make a huge deal out of it. A hundred or so people seemed to download it and I haven't heard a peep about it since so I guess it works? It's fairly functional... it's certainly more than sufficient to do most common tasks for SJQ from the web UI. It also allows viewing of the queue from the web. With all that said, I hope the theme of all of these posts are clear: use it, love it, enjoy it, but realize there are zero planned updates to what's there. But I do accept and will gladly build user supplied patches.

[wayner]

Originally Posted by Slugger

And that Groovy script could then inject tasks into your SJQ queue. A really small groovy script is all you'd need to simply throw an arbitrary task into the SJQ task queue. You can then do all the heavy lifting via SJQ once you get that task in there. If I really wanted to trigger SJQ tasks on unsupported events and I didn't own the code, this is how I'd do it.

Great - sorry to be such a nag, but thanks for all of the work that you have done for the Sage user community.

Your plugins have made Sage hugely more useful and I use them all on a many times per day basis. I get Tweets and emails from SageAlert several times per day, SJQ processes all of my recordings, I get a daily email listing my recordings that uses Groovy and I use the Sage Web Server all the time.

And if and when hockey ever starts up again I will get to use the most brilliant of all, SRE.

[wayner]

My system just just filled up due to lobs.db entries. Do these come from SJQ or another plugin.

The logs were filled with this:

===== Wed Nov 07 21:37:20 EST 2012 =====

LOG4J: Configured Logging for: sagex-api using file: sagex-api.log4j.properties
----- stdout -----

ERROR: Invalid environment data passed to scritpt!
------------------

[Slugger]

Yeah... likely a job was added to the queue and the media file for that object was deleted or somehow invalidated and the job got caught in an infinite loop of running, being sent back to the queue, retrying, back to the queue, retrying, etc. This issue was fixed long ago, but it seems you've found another code path to the issue.

The fix: Inspect your SJQ job queue and remove either 1) everything or 2) if you can spot the culprit then just remove that job. You'll also want to cleanup the H2 lobs cache.

Unfortunately, unless you can pin point exactly what's causing it (and ideally reproduce it), I don't plan on investigating too deeply at this point (re: project EOL) unless you get lucky enough and I encounter the same issue in my environment at some point. In that case, I'm likely to dig deep into it and try to fix it.

But the cause and fix I outline above is your next plan of attack.

[Slugger]

Originally Posted by Slugger

The fix: Inspect your SJQ job queue and remove either 1) everything or 2) if you can spot the culprit then just remove that job. You'll also want to cleanup the H2 lobs cache.

By everything, I meant all active, incomplete tasks (taks in WAITING or RUNNING state).

[wayner]

There was nothing WAITING or RUNNING but I did delete all FAILED tasks. I then restarted the SageTV service. I will keep an eye on it to see what happens now.

[Skirge01]

I'm trying to get comskip working with SJQ4 now and, thanks to Slugger's help with code repurposed from (I think) wayner. I'm using the SJQ service so that I understand everything going on in the UI and because it's what I was using with SJQ3. Anyhow, I want to see if I understood the guide correctly.

This is from the guide:

task.mytask.exe=C:/bin/mytask.exe
# task.mytask.args=/f /g /t
task.mytask.test=C:/scripts/mytask_precheck.groovy
# task.mytask.testargs=
# task.mytask.schedule=* * * * *
# task.mytask.resources=100
# task.mytask.maxprocs=1
# task.mytask.rcmin=0
# task.mytask.rcmax=0

Am I correct in thinking that I need it to say this:

task.mytask.exe=C:/comskip/comskip.exe
# task.mytask.args=/f /g /t
task.mytask.test=C:/scripts/comskip.groovy
# task.mytask.testargs=
# task.mytask.schedule=* * * * *
task.mytask.resources=33
task.mytask.maxprocs=3
# task.mytask.rcmin=0
# task.mytask.rcmax=0

...with comskip.groovy being the aforementioned code I repurposed?

Also, with how I have the resources set, is setting the maxprocs redundant? Well, I guess it wouldn't be if I had a task which required only 1 resource, right? I think I'm starting to understand this.

Is that everything? Is the only other step to register the task client and then assign the task to each of my favorites? Ouch... that's going to take some time with nearly 100 of them... LOL! Maybe I'll find something else in the guide that says there's an easier way.

[Slugger]

Originally Posted by Skirge01

I'm trying to get comskip working with SJQ4 now and, thanks to Slugger's help with code repurposed from (I think) wayner. I'm using the SJQ service so that I understand everything going on in the UI and because it's what I was using with SJQ3. Anyhow, I want to see if I understood the guide correctly.

This is from the guide:

task.mytask.exe=C:/bin/mytask.exe
# task.mytask.args=/f /g /t
task.mytask.test=C:/scripts/mytask_precheck.groovy
# task.mytask.testargs=
# task.mytask.schedule=* * * * *
# task.mytask.resources=100
# task.mytask.maxprocs=1
# task.mytask.rcmin=0
# task.mytask.rcmax=0

Am I correct in thinking that I need it to say this:

task.mytask.exe=C:/comskip/comskip.exe
# task.mytask.args=/f /g /t
task.mytask.test=C:/scripts/comskip.groovy
# task.mytask.testargs=
# task.mytask.schedule=* * * * *
task.mytask.resources=33
task.mytask.maxprocs=3
# task.mytask.rcmin=0
# task.mytask.rcmax=0

...with comskip.groovy being the aforementioned code I repurposed?

This looks about right to me.

Also, with how I have the resources set, is setting the maxprocs redundant? Well, I guess it wouldn't be if I had a task which required only 1 resource, right? I think I'm starting to understand this.

Depends. It's kind of redundant, but using both lets you do different things. Let's say you only want to ever run 1 comskip at once, but you want to also run other tasks while that one comskip is running. In such a case, you might set resources for comskip to 50, but maxprocs to 1. This way no more than 1 comskip will ever run at once (on this client), but you also keep 50 resources free for other tasks that may come up while that comskip is running.

Is that everything? Is the only other step to register the task client and then assign the task to each of my favorites? Ouch... that's going to take some time with nearly 100 of them... LOL! Maybe I'll find something else in the guide that says there's an easier way.

What would I do? I'd write a groovy script that assigns the tasks to my favs in bulk and get SJQ to run it for me. (Actually, I'd do it slightly different, but since you've got SJQ setup, this is probably the easiest route to take.)

Quick, off the cuff example (which may not exactly work, I didn't test it, but should show you what you're trying to do).

// Attach the 'COMSKIP' task to every fav I have
FavoriteAPI.GetFavorites().each {
   FavoriteAPI.SetFavoriteProperty(it, 'SJQ4_RecordingStopped', 'COMSKIP')
}

That sure beats clicking thru each fav and editing it? Save the above as a .groovy file and then configure a task in your task client to run it then queue the task to execute it just once.

Of course, you probably want to only apply comskip to certain favs -- ones not recording from HBO, etc. It wouldn't be much fun if I wrote everything, so I leave that as an exercise for the reader.

Happy scripting...