Creating nightly task from STVi

[evilpenguin]

I'm looking to write some studio code that will run an executable nightly (i.e. every night at 2am, run this process), can someone point me in the right direction?

[tmiranda]

Without knowing the details it sounds like you could do this from Java in a "standard" plugin using TimerTask(). Does it have to be in Studio? Remember that if the UI goes away (extender turned off, client or placeshifter disconnected) there is no UI so you can't guarantee the process will execute.

Tom

[GKusnick]

It's doable, using Fork(), Wait(), and ExecuteProcess(). But are you sure you really want to do it from an STVI? That would have the effect of kicking off a separate instance of the executable for each connected client. Typically you'd want to launch just one instance, regardless of how many clients are connected. For that, your best bet is a Standard plugin written in Java and using a java.util.Timer to kick off your executable at predefined times or intervals.

[evilpenguin]

Yeah, that's really the proper way of doing it, I was just hoping to get away without writing any *shudder* Java. Oh well, can someone point me towards Standard Plug-in 101, I can't seem to find any official info?

Edit: Found the .doc hidden in this thread, prolly should be added to one of the Studio Stickies.

[tmiranda]

EP,

If you like I can email you the Java framework/stub code that I use for standard plugins. PM your email address if interested.

Tom

[GKusnick]

Also note that my Tools Library includes an abstract class that makes writing a Standard plugin pretty painless. Just extend that class and fill in the bits specific to your plugin. I think Stuckless has something similar in his Sagex library.

Mine also allows you to define your config options (if any) in XML form, so there's even less Java code to write.

I can post a simple skeleton plugin if you like.

[evilpenguin]

I found these two threads which seem to be pretty helpful for a complete newb...

Standard Plugin - Sanity check please -I imagine this is pretty close to the stub code you're talking about. Is the framework you're talking about something special that gets imported into the IDE for quick development? If so please do send it my way, i'll PM you the address.

Pre-v7 Instructions for setting up Eclipse - I'd love it if someone could expand on these instructions for working with the v7 Standard plug-in interface.

[evilpenguin]

Originally Posted by GKusnick

Also note that my Tools Library includes an abstract class that makes writing a Standard plugin pretty painless. Just extend that class and fill in the bits specific to your plugin. I think Stuckless has something similar in his Sagex library.

Mine also allows you to define your config options (if any) in XML form, so there's even less Java code to write.

I can post a simple skeleton plugin if you like.

Please do post an example, i'm a little lost on how to get started.

[GKusnick]

Here you go:

public class MyPlugin extends XmlConfig.Plugin
    {

    public MyPlugin(sage.SageTVPluginRegistry reg, boolean fReset)
        {
    //  Load XML config info from JAR file resource.
    //  (You can also use an external XML file if that's simpler for you.)
        super(XmlConfig.FromResource(MyPlugin.class, "MyPlugin.config.xml"));
        
        if (fReset)
            resetConfig();

        }

    public void start()
        {
        StartTimerTask();
        }

    public void stop()
        {
        StopTimerTask();
        }

    public void setConfigValue(String szSetting, String szValue)
        {
    //  Do any required validation of the setting value.

        super.setConfigValue(szSetting, szValue);

    //  Restart the task with the new settings.
        StopTimerTask();
        StartTimerTask();
        }

    private java.util.Timer timer = null;
    private java.util.TimerTask task = null;

    private void StartTimerTask()
        {
    //  Get task start time and period from .properties file.
    
        task = new java.util.TimerTask()
            {
            public void run()
                {
            //  Do your thing.
                }
            };
        
        if (timer == null)
            timer = new java.util.Timer("MyTimer", true);
        timer.scheduleAtFixedRate(task, tStart, dtPeriod);

        }

    private void StopTimerTask()
        {
        if (task != null)
            {
            task.cancel();
            task = null;
            }
        }

    }

Disclaimer: this is stripped down from an actual working plugin and has not been tested in this exact form, but it should cover the essentials.

Edit: The explanation of the XML config format is in the XmlConfig Javadocs included with my library.

[Slugger]

EP, can I ask what you're up to? I'm sort of starting the design work for SJQv4 and one of the items at the top of the list is to bring a good old fashioned crontab to SageTV, which would allow you to schedule SageTV specific tasks to run on a regular schedule, with a few additions (such as conditional execution of the scheduled tasks based on the state of the server, etc.). My idea has become rather large and extravagant, so not sure if it will actually happen (as my ideas expand, my excitement level/desire to write it lowers), but if you're heading down the same road then maybe you'll save me a bunch of work.

[PLUCKYHD]

Originally Posted by evilpenguin

Please do post an example, i'm a little lost on how to get started.

I would also offer up to do the "java" for you if you don't want to read up.I can easily make you a standard plugin with the code you need.

cheers,

pluckyhd