Plugin: SJQv4

[Skirge01]

I just "finished" the following code and would like to solicit feedback as to whether I'm even close. For example, is it even possible to do an IF, followed by several ELSE's? Even if the code is wrong, I think it's pretty clear what I'm attempting to do. Don't laugh too hard, guys! I don't do this regularly.

Rather than the CODE tag, I used PHP, since the tabs were reflected accurately.

PHP Code:

Object mediaFile = MediaFileAPI.GetMediaFileForID(SJQ4_METADATA.get("SJQ4_ID").toInteger())
String channel = AiringAPI.GetAiringChannelName(mediaFile)
String file = SJQ4_METADATA.get("SJQ4_PATH") + SJQ4_METADATA.get("SJQ4_LAST_SEGMENT")
String fileType = SJQ4_METADATA.get("SJQ4_LAST_SEGMENT_TYPE")

if(channel ==~ /WABCDT|WCBSDT|WNBCDT|WPIXDT|SYFYHD|TNTHD|USAHD|SPIKEHD|FXHD/) {
    println "Running PRIMARYHDSKIP"
    println file
    def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-PRIMARYHD.ini \"${file}\"".execute()
    command.consumeProcessOutput()
    command.waitFor()
    if (command.exitValue()) {
        return 1
    }
    else {
        return 0
    }
    else if(channel ==~ /WNYWDT/) {
        println "Running WYNWDTSKIP"
        println file
        def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-WNYWDTSKIP.ini \"${file}\"".execute()
        command.consumeProcessOutput()
        command.waitFor()
        if (command.exitValue()) {
            return 1
        }
        else {
            return 0
        }
        else if(channel ==~ /HSTRYHD/) {
                println "Running HSTRYHDSKIP"
                println file
                def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-HSTRYSKIP.ini \"${file}\"".execute()
                command.consumeProcessOutput()
                command.waitFor()
                if (command.exitValue()) {
                    return 1
                }
                else {
                    return 0
                }
                else {
                    if(channel !=~ /WNYWDT|WABCDT|WCBSDT|WNBCDT|WPIXDT|SYFYHD|TNTHD|USAHD|SPIKEHD|FXHD|HSTRYHD|HBO.*|ACMAXHD|5MAXHD|HDNETMV|MAX.*|MOMAX|STZ.*|ENC.*|SHO.*|TMC.*|PPV.*/)
                    println "Running PRIMARYHDSKIP (Default)"
                    println file
                    def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-PRIMARYHDSKIP.ini \"${file}\"".execute()
                    command.consumeProcessOutput()
                    command.waitFor()
                    if (command.exitValue()) {
                        return 1
                    }
                    else {
                        return 0
                    }
                }
        }
    }
} 


[Slugger]

I tried to correct your unbalanced { }, but I don't have access to a groovy parser at this exact moment to confirm my edits are 100% accurate, but I think they're at least closer to valid. I also inlined some comments on the code.

The script looks relatively sound to me... I'd probably refactor some of the common code for easier maintenance, but nothing I'd worry about for now (and so I didn't mention any of that in my comments).

// I'm fairly certain your parenthesis don't match up, I don't have access to a groovy parser at the moment so
// this may still not be right, but I'm fairly certain what you pasted is invalid; I tried to fix it with the naked eye

Object mediaFile = MediaFileAPI.GetMediaFileForID(SJQ4_METADATA.get("SJQ4_ID").toInteger()) 
String channel = AiringAPI.GetAiringChannelName(mediaFile) 

/*
   Building the file name from the SJQ env vars is fine, but you already have the media file object so
   you might find it easier/more reliable to use the MediaFileAPI functions to extract the file name.
   But then again, if this is working for you then that's fine.
*/
String file = SJQ4_METADATA.get("SJQ4_PATH") + SJQ4_METADATA.get("SJQ4_LAST_SEGMENT") 
String fileType = SJQ4_METADATA.get("SJQ4_LAST_SEGMENT_TYPE") 

if(channel ==~ /WABCDT|WCBSDT|WNBCDT|WPIXDT|SYFYHD|TNTHD|USAHD|SPIKEHD|FXHD/) { 
    println "Running PRIMARYHDSKIP" 
    println file 
    // You don't have to worry about quoting args, etc. if you build a command array
    // def command = ['C:/comskip/comskip.exe', '--ini=C:/comskip/comskit-PRIMARYHD.ini', file].execute()
    def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-PRIMARYHD.ini \"${file}\"".execute() 
    command.consumeProcessOutput() // Are you sure you don't want to capture the output for possible debugging?  consumeProcessOutput(System.stdout, System.stderr) will capture it in SJQ logs
    command.waitFor() 
    if (command.exitValue())
        return 1 
    else
        return 0 
} else if(channel ==~ /WNYWDT/) { 
	println "Running WYNWDTSKIP" 
	println file 
	def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-WNYWDTSKIP.ini \"${file}\"".execute() 
	command.consumeProcessOutput() 
	command.waitFor() 
	if (command.exitValue())
            return 1 
	else
            return 0 
} else if(channel ==~ /HSTRYHD/) { 
	println "Running HSTRYHDSKIP" 
	println file 
	def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-HSTRYSKIP.ini \"${file}\"".execute() 
	command.consumeProcessOutput() 
	command.waitFor() 
	if (command.exitValue())
            return 1 
	else
            return 0 
} else if(channel !=~ /WNYWDT|WABCDT|WCBSDT|WNBCDT|WPIXDT|SYFYHD|TNTHD|USAHD|SPIKEHD|FXHD|HSTRYHD|HBO.*|ACMAXHD|5MAXHD|HDNETMV|MAX.*|MOMAX|STZ.*|ENC.*|SHO.*|TMC.*|PPV.*/) {
	println "Running PRIMARYHDSKIP (Default)" 
	println file 
	def command = "\"C:/comskip/comskip.exe\" --ini=C:/comskip/comskip-PRIMARYHDSKIP.ini \"${file}\"".execute() 
	command.consumeProcessOutput() 
	command.waitFor() 
	if (command.exitValue())	
            return 1 
	else
            return 0 
} else {
        println 'Not running comskip for this recording!'
        return 0
}

[Taddeusz]

The only thing I see is that comskip's error level is backwards. So if comskip returns a 1 you need to return a 0 to SJQ and visa versa.

[Slugger]

Originally Posted by Taddeusz

The only thing I see is that comskip's error level is backwards. So if comskip returns a 1 you need to return a 0 to SJQ and visa versa.

Right... actually isn't 0 OR 1 valid for comskip (pretty sure that's right). So just adjust the if statements appropriately (another reason to refactor )

[jbuszkie]

I want to move to a 64 bit system to gain more memory. I have one firewire box that needs 32 bit. So I was thinking of moving that to a standalone
32 bit machine and using it as a network encoder, if possible (But that's a different question in a different thread).

If that works, I don't necessarily want to have this 32 bit machine on 24/7. I'd like to only turn it on when it needs this other tuner. Does SJQ have the ability to sniff what tuners are needed coming up so it could act and wake up the 32 bit system?

Thanks!

Long live Sage!

Jim

[Slugger]

Originally Posted by jbuszkie

I want to move to a 64 bit system to gain more memory. I have one firewire box that needs 32 bit. So I was thinking of moving that to a standalone
32 bit machine and using it as a network encoder, if possible (But that's a different question in a different thread).

If that works, I don't necessarily want to have this 32 bit machine on 24/7. I'd like to only turn it on when it needs this other tuner. Does SJQ have the ability to sniff what tuners are needed coming up so it could act and wake up the 32 bit system?

Thanks!

Long live Sage!

Jim

In theory, yes, but I've never tried it so can't say it would work for sure. SJQ can scan thru the scheduled recordings list and look at the scheduled tuners for those recordings and then you can react to that. However, my guess is that if this 32bit machine isn't on then Sage won't see the network tuner and will then schedule around it so no recordings will ever be scheduled on that tuner while the machine is off. Again, that's only an educated guess as to what may happen, you'll have to actually test it. But can SJQ see what tuners recordings are scheduled on? Yes.

[Skirge01]

Originally Posted by Slugger

I tried to correct your unbalanced { }, but I don't have access to a groovy parser at this exact moment to confirm my edits are 100% accurate, but I think they're at least closer to valid. I also inlined some comments on the code.

The script looks relatively sound to me... I'd probably refactor some of the common code for easier maintenance, but nothing I'd worry about for now (and so I didn't mention any of that in my comments).

Thanks so much, Slugger. That was much more than I was expecting! I didn't get to test it out this past weekend, but I still wanted to thank you for the work. Hopefully, I'll find some time this coming weekend to play with the server again.

[jbuszkie]

Originally Posted by Slugger

In theory, yes, but I've never tried it so can't say it would work for sure. SJQ can scan thru the scheduled recordings list and look at the scheduled tuners for those recordings and then you can react to that. However, my guess is that if this 32bit machine isn't on then Sage won't see the network tuner and will then schedule around it so no recordings will ever be scheduled on that tuner while the machine is off. Again, that's only an educated guess as to what may happen, you'll have to actually test it. But can SJQ see what tuners recordings are scheduled on? Yes.

You may be right about it not seeing the 32 bit tuner.. But it might work if it's powered on when I start sage. Then I might be able to turn it off.
This might be more trouble than it's worth...

Maybe I can just run a SJQ script to check if there ever is a conflict and then send me an e-mail and I can turn it on manually...

Or.. Maybe I'll try to run a 32 machine in a VM and then I don't have to worry about it being on 24/7.. hmm...

Or.. Give up on Firewire recording and just rely on my 3 prime tuners and 2 HDHR tuners for locals...

[gdippel]

Just in the past day my tasks (which have been previously working fine) have been failing. I've attached a screenshot of the beginning of the log file. I haven't knowingly changed anything (I running Windows XP) and I tried rebooting, but the problems persists. Should I reinstall Java? I'm at a loss.

[Slugger]

The sagex remote API plugin is not functioning properly. I saw there was an update for that plugin earlier this week. Did you apply that update? If so, did you restart Sage after doing so? If you did restart Sage and that didn't help then I'd start looking at that plugin. If that plugin isn't working then SJQ task clients cannot function.

[gdippel]

I seemed to have missed that plugin update. I just installed it and I now have a running task. Slugger, thanks for the quick reply. I should probably setup your groovy script that checks for plugin updates.

BTW, this goes to show how invaluable this forum is for Sage users. I know this has been discussed before, but is there some contingency plan should this forum cease? I'm sure Jeff will give us some advance notice, but it would be nice to be prepared to start a sub forum on, say, the AVS site.

[wayner]

Here's another side benefit to SJQv4.

My server is on a UPS but one of my clients running SJQv4 client is not. If I get a power flash it causes the PC to reboot which causes the SJQ client to go offline. This triggers a Sage warning and with SageAlert I get an email telling me that the client is offline which means that I have lost power (or my PC has crashed).

[wayner]

Is it possible to Power Off an extender via Groovy code within SJQv4? You can do this from the Sage Web server but I couldn't find the relevant command in the Sage API.

[Slugger]

Originally Posted by wayner

Is it possible to Power Off an extender via Groovy code within SJQv4? You can do this from the Sage Web server but I couldn't find the relevant command in the Sage API.

Sure you can! The task client and web server plugins include my gtools plugin as a dependency. So use these javadocs to find the helpers of interest. For powering extenders on/off, you'll want to read up on GlobalHelpers. Just be sure you import the classes of interest at the top of your groovy scripts then you should be good to go. I use a lot of the helpers in that jar for various things in my environment.

[Slugger]

By the end of this weekend, you will notice a new update for the Groovy plugin. If you upgrade the web server UI later this weekend (when that update becomes available), you will have Groovy updated for you as part of that update.

This update moves Groovy from 1.7 to 2.0. Though a significant jump, it shouldn't have a major effect on the majority of users. The only issue users may run into is the use of private fields in your scripts. Groovy 2.0 is more strict about the use of private fields (and methods) in scripts (and in general). I don't suspect this is an issue for most SJQ users, but I'm bringing it to your attention. If you're affected by this you'll know it because your tasks and/or test scripts will suddenly start to fail. The error spit out by Groovy should be sufficient to fix things up quickly, but if not then post issues here.

The move to 2.0 opens up some interesting doors, should I choose to ever tackle my todo/wish list for SJQ at some point. One of the major milestones in even beginning to start on the list was a required upgrade to Groovy 2.0. My work on the Schedules Direct plugin has kind of forced my hand and so here we are. Am I ever going to actually tackle the list? Very unlikely at this point, but with the upgrade to Groovy 2.0, the possibility is at least a little more likely today.

[wayner]

Originally Posted by Slugger

The move to 2.0 opens up some interesting doors, should I choose to ever tackle my todo/wish list for SJQ at some point. One of the major milestones in even beginning to start on the list was a required upgrade to Groovy 2.0.

Can you elaborate on this a wee bit? Any chance of you doing any improvements/enhancements to the Web server? 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. It would also be nice to be able to see your Java heap status from the web interface.

[Slugger]

Originally Posted by wayner

Can you elaborate on this a wee bit? Any chance of you doing any improvements/enhancements to the Web server? 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. It would also be nice to be able to see your Java heap status from the web interface.

My wish list for SJQ is mostly backend; how I integrate and execute groovy scripts within the SJQ engine. Groovy 2.0 brings a lot of features that allow me to not have to run all user scripts in a separate JVM, but instead I can run them within the SageTV JVM process. I know, I know, nothing exciting for most, but the performance gains would be significant and it would also greatly simplify the code used to marshall user scripts from the Sage JVM > separate execution JVM > back to the Sage JVM for final processing. Most of my items are things like this. But, with that said, most of these items are rather large undertakings and so I probably won't ever bother at this stage (actually, it's almost a guarantee). The Schedules Direct EPG effort is taking enough of my time and by the time I'm done with it, I'll likely be ready to head back to Sage dev retirement.

Additional web server enhancements: I'd like to, but it's not priority. Honestly, in an ideal world, I'd never release another build of the web server. Just wanting to upgrade Groovy from 1.7 to 2.0 was a nightmare, mostly of my own doing, but a nightmare none the less. Three or four solid evenings lost on figuring out how to get newer versions of Groovy working with the Groovy support in the web UI. As I said, the issues were all my own doing, which is why I'd rather not touch anything that is happily working. But in this case, I really wanted Groovy 2.0 for the new Schedules Direct plugin so I had to bite the bullet, which is why you're getting a new web UI build (already in the repo).

I have no plans for any further web UI builds at this point. The SJQ menu would be ideal and if I had remembered before delivering today's build I would have added it, but I didn't. Instead, I made a bookmark in my browser long ago to "solve" that issue.

[wayner]

Originally Posted by Slugger

Groovy 2.0 brings a lot of features that allow me to not have to run all user scripts in a separate JVM, but instead I can run them within the SageTV JVM process.

This would be useful for me since I have lots of extenders and I often run into JVM constraints. But I can't run SJQ tasks to find out how much JVM is available since it use a different VM. I may deal with this problem in another way - tmiranda's Java Heap monitor can kick off System Messages and I can then use SageAlert to kick off a process.

With respect to the web UI - is this something that a user (like me) can easily adapt ourselves. It would also be nice to link to other user defined Groovy web processes - currently I have to do that by building my own web page.

[Slugger]

Originally Posted by wayner

With respect to the web UI - is this something that a user (like me) can easily adapt ourselves. It would also be nice to link to other user defined Groovy web processes - currently I have to do that by building my own web page.

Short answer: no. Why? Because the js file that that the web ui menu is loaded from is buried in the war file and you can't mod the war file without making Sage complain that the file was tampered with. With that said, doing it only produces a warning, Sage would still happily load the modified war file.

Alternatively, you could mod the menu file in the exploded directory that the app runs from, but that's not good because everytime Sage and/or the web ui and/or jetty is restarted then your mods are clobbered.

At one point I started working on the ability to load user edits to the menu from a separate file, but that didn't come about for reasons I can't remember (there were technical roadblocks slowing me down so I didn't bother to finish it).

[Slugger]

Originally Posted by wayner

With respect to the web UI - is this something that a user (like me) can easily adapt ourselves. It would also be nice to link to other user defined Groovy web processes - currently I have to do that by building my own web page.

Well, it's your lucky day! There just happened to be a bug with the web based plugin manager that I really wanted fixed. Since I was doing another build, I took the time to rip out the old js menu and replaced it with a new one and set it up so users can inject custom items into the menu. An SJQ Web UI update should be in the repo shortly that injects the SJQ menu into the web UI.