Your IP : 216.73.216.209


Current Path : /scripts/
Upload File :
Current File : //scripts/cpuser_service_manager

#!/usr/local/cpanel/3rdparty/bin/perl

# cpanel - scripts/cpuser_service_manager          Copyright 2022 cPanel, L.L.C.
#                                                           All rights reserved.
# copyright@cpanel.net                                         http://cpanel.net
# This code is subject to the cPanel license. Unauthorized copying is prohibited

use strict;
use warnings;

package scripts::cpuser_service_manager;

use App::CmdDispatch;

my $cmds = {
    add => {
        code     => \&add,
        clue     => "add <service_name> --init-script=<ABS_PATH> (or --ubic-service=<ABS_PATH>)",
        abstract => "Setup a service",
        help     => "Setup the given user managed and monitored service",
    },
    rem => {
        code     => \&rem,
        clue     => "rem <service_name>",
        abstract => "Remove a service",
        help     => "Remove the given user managed and monitored service",
    },
    list => {
        code     => \&list,
        clue     => "list",
        abstract => "List your services",
        help     => "List your user managed and monitored services",
    },
    info => {
        code     => sub { my ( $app, @args ) = @_; die "too many arguments\n" if @args; print <DATA> },    # simplify PATH info w/ CPANEL-22345 fix when available
        clue     => "info",
        abstract => "Info on this tool/feature",
        help     => "Information about how this works and what you can do after a service is added",
    },
};

my $hint_blurb = "This tool supports the following commands (i.e. $0 {command} …):";
my $opts       = {
    'help:pre_hint'  => $hint_blurb,
    'help:pre_help'  => "Add/Remove/List user managed and monitored services.\n\n$hint_blurb",
    default_commands => "help",
    alias            => { remove => "rem" },
};

run(@ARGV) if !caller;

sub run {
    my (@argv) = @_;
    local $ENV{TERM} = $ENV{TERM} || "xterm-256color";    # non-CLI modulino avoid needless: Cannot find termcap: TERM not set at …/Term/ReadLine.pm line 373.
    return App::CmdDispatch->new( $cmds, $opts )->run(@argv);
}

################
#### commands ##
################

sub add {
    my ( $app, $service_name, @flags ) = @_;

    eval {
        require Ubic;                                # this means ubic-admin is installed
        require Ubic::Service::InitScriptWrapper;    # this means the --init-script setup will work
    };
    if ($@) {
        die "Ubic must be installed to add a service!\n";
    }

    $service_name = _validated_service_name( $app, $service_name );

    my $service_dir = _get_service_dir();

    if ( -l "$service_dir/$service_name" || -e _ ) {
        die "The “$service_name” service already exists.\n";
    }

    # Tiny race here w/ worst case being an error or they over write a file that they just wrote, so no biggy  ¯\_(ツ)_/¯

    my $opts = _validated_add_flags( $app, @flags );

    # would be cool if Cpanel::FindBin (or whatever) did this for us: CPANEL-22345
    my $real_perl  = readlink("/usr/local/cpanel/3rdparty/bin/perl");
    my $cp_bin_dir = $real_perl;
    $cp_bin_dir =~ s{/perl$}{};
    local $ENV{PATH} = "$cp_bin_dir:$ENV{PATH}";    # not only does this allow it to find our ubic-admin, it allows its env-shebang to pick up our perl

    my $orig_umask = umask(0027);
    system("ubic-admin setup --batch-mode --local --no-sticky-777") && die "Could not ensure base ubic configuration: $?\n";    # idempotent
    _cpanelify_ubic_watchdog_cron();
    _prepend_comment_to_ubic_cnf();

    if ( $opts->{type} eq 'init' ) {
        _setup_init( $opts->{path}, $service_dir, $service_name );
    }
    elsif ( $opts->{type} eq "ubic" ) {
        symlink( $opts->{path}, "$service_dir/$service_name" ) or die "Could not create “$opts->{path}”: $!\n";
    }
    else {
        umask($orig_umask);
        _bail( $app, "Something is wrong …" );    # juuuust in case we add a bug …
    }

    umask($orig_umask);
    return;
}

sub rem {
    my ( $app, $service_name ) = @_;
    $service_name = _validated_service_name( $app, $service_name );

    my $service_dir  = _get_service_dir();
    my $service_file = "$service_dir/$service_name";

    if ( !-e $service_file ) {
        print "The “$service_name” service does not exist.\n";
        return 1;
    }
    else {
        print "Removing “$service_name” service …\n";
        unlink($service_file);
        if ( -e $service_file ) {
            die "Failed to delete “$service_file”: $!\n";
        }
        return 1;
    }

    return;
}

sub list {
    my ($app) = @_;
    _bail( $app, "“list” does not take any arguments" ) if @_ > 1;

    my $service_dir = _get_service_dir();
    return if !-d $service_dir;
    opendir( my $dh, $service_dir ) or die "Could not readdir “$service_dir”: $!\n";

    for my $service ( sort readdir($dh) ) {
        next if $service eq '.' || $service eq '..';
        print "$service\n";
    }

    closedir($dh);

    return;
}

###############
#### helpers ##
###############

sub _get_cmd {
    return $cmds;
}

sub _bail {
    my ( $app, $msg ) = @_;
    chomp($msg);

    die "$msg\n" if $ENV{ __PACKAGE__ . "::bail_die" };    # for API calls, otherwise:

    warn "$msg\n";
    $app->help();
    exit(1);                                               # there is no return()ing from this lol
}

sub _prepend_comment_to_ubic_cnf {

    # comments crate uninit warnings in ubic's conf parser :/
    my $ubic_comment  = "IMPORTANT = Do not edit this cPanel User Service Manager generated file!";
    my $ubic_cnf_path = _get_homedir() . "/.ubic.cfg";

    require Cpanel::LoadFile;
    my $ubic_cnf = Cpanel::LoadFile::load($ubic_cnf_path);
    if ( open my $fh, '>', $ubic_cnf_path ) {
        print {$fh} "$ubic_comment\n";
        print {$fh} $ubic_cnf;
        close $fh;
    }
    else {
        warn "Could not prepend “ubic_comment” line to $ubic_cnf_path: $!\n";
    }

    return;
}

sub _cpanelify_ubic_watchdog_cron {

    # Cpanel::Cron::Utils::run_crontab(): does not work under jailshell, and can't - under normal shell
    my @crontab = `crontab -l`;
    return if !@crontab;

    for my $line (@crontab) {
        if ( $line =~ m/ubic-watchdog ubic\.watchdog/ ) {
            $line = "\n# Do not edit the cPanel User Service Manager generated cronjob for Ubic!\n";    # any changes need synced w/ Whostmgr/Accounts/Modify.pm, specifically _update_ubic_conf()
            $line .= '* * * * * PATH=$(dirname $(readlink /usr/local/cpanel/3rdparty/bin/perl)):$PATH ubic-watchdog ubic.watchdog >>$HOME/ubic/log/watchdog.log 2>>$HOME/ubic/log/watchdog.err.log';
            $line .= "\n\n";
        }
    }

    return _write_crontab_lines( \@crontab );
}

sub _write_crontab_lines {
    my ($crontab_ar) = @_;

    open my $fh, '|-', 'crontab -' or die "Can't run 'crontab -': $!\n";
    print {$fh} @{$crontab_ar} or die "Can't write to crontab pipe: $!\n";
    close $fh                  or die "Can't close crontab pipe: $!\n";

    return 1;
}

sub _get_homedir {
    return ( getpwuid($>) )[7];
}

sub _get_service_dir {
    my $homedir = _get_homedir();
    return "$homedir/ubic/service";    # TODO: get from $homedir/.ubic.cfg {service_dir} if set
}

sub _validated_service_name {
    my ( $app, $service_name ) = @_;

    if ( !defined $service_name || $service_name !~ m/^[\w-]+(?:\.[\w-]+)*$/ ) {    # regexp is $service_name_re from Ubic.pm v1.60
        _bail( $app, "Invalid service name" );
    }

    return $service_name;
}

sub _validated_add_flags {
    my ( $app, @flags ) = @_;
    _bail( $app, "too many arguments" ) if @flags > 1;

    if ( $flags[0] =~ m/^--init-script=(.+)/ ) {
        my $init = $1;
        _check_path( $app, "--init-script", $init );
        return { path => $init, type => "init" };
    }
    elsif ( $flags[0] =~ m/^--ubic-service=(.+)/ ) {
        my $ubic = $1;
        _check_path( $app, "--ubic-service", $ubic );
        return { path => $ubic, type => "ubic" };
    }
    else {
        _bail( $app, "--init-script or --ubic-service is required" );
    }

    return;
}

sub _check_path {
    my ( $app, $flag, $path ) = @_;

    if ( $path !~ m{^/} ) {
        _bail( $app, "$flag value must be an absolute path" );
    }

    if ( !-e $path || !-r $path ) {
        _bail( $app, "$flag value does not exist or is not readable" );
    }

    return;
}

sub _setup_init {
    my ( $abs_path_to_init, $service_dir, $service_name ) = @_;

    if ( open my $fh, ">", "$service_dir/$service_name" ) {
        my $abs_path_to_init_escaped = $abs_path_to_init;
        $abs_path_to_init_escaped =~ s/'/\\'/g;

        my $created_by_init_file_flag_value = $abs_path_to_init ne $abs_path_to_init_escaped ? "'$abs_path_to_init_escaped'" : $abs_path_to_init;

        print {$fh} <<"END_UBIC_SERVICE_FILE";
# Created by `$0 add $service_name --init-file=$created_by_init_file_flag_value`
use Ubic::Service::InitScriptWrapper;
Ubic::Service::InitScriptWrapper->new('$abs_path_to_init_escaped');
END_UBIC_SERVICE_FILE

        print "Installed “$service_name” service.\n";
        return 1;
    }
    else {
        die "Could not create “$service_dir/$service_name”: $!\n";
    }

    return;
}

1;

__DATA__
____
A cPanel user managed and monitored service allows users to run daemons as themselves.

Aside from security benefits it is very convenient. The subsystem used to accomplish this is known as Ubic (a “polymorphic service manager”).

This script will setup ubic on your account (if its not already) which includes setting up ~/ubic, ~/.ubic.cfg (do not edit this or things will not work correctly), and a cronjob for a ubic watchdog process that will monitor your service (e.g. to restart it if it stops running or isn’t running because the server just rebooted).

After you have a service setup you can manage it manually w/ the `ubic` command, the most common commands are:

    `ubic status <service_name>`
    `ubic start <service_name>`
    `ubic stop <service_name>`
    `ubic restart <service_name>`

There are others, `man ubic` for details.

Note: If `ubic` is not in your PATH you will need to add it. For example, if you use BASH you could add this to your .bashrc:

    export PATH=$(dirname $(readlink /usr/local/cpanel/3rdparty/bin/perl)):$PATH

This script supports two types of approaches:

1. An existing init script

  This allows you to turn any LSB-compliant init script into a user managed and monitored service.

2. An existing ubic service file.

  This allows you to do things however you like using Ubic::Service based scripts.

  An example to get you started is the SYNOPSIS for a PSGI based app running under Starman: https://metacpan.org/pod/Ubic::Service::Starman

  Let’s say you have an app installed in ~/apps/foo/ and that has ~/apps/foo/bin/ubic.service that uses Ubic::Service::Starman.

  All you have to do is run `$0 add foo --ubic-service=~/apps/foo/bin/ubic.service` and voilà it is ready to go!

  Since, in this case, the ubic entry is a symlink the application can update it code and everything will just keep working!
––––

Rosenblum TV: Video training, virtual workshops, classes, tutorials
logologologologo
  • About
  • What We Do
  • Our Clients
  • Case Studies
    • The BBC
    • CBS News
    • New York Times Television
    • Spectrum News
    • The Newark Star-Ledger
    • The United Nations
    • McGraw/Hill
    • Oyster Yachts
    • Scottish Environmental Protection Agency
  • The Power of Storytelling
  • Why iPhones?
  • Michael on Media
  • Books
  • Contact
  • About
  • What We Do
  • Our Clients
  • Case Studies
    • The BBC
    • CBS News
    • New York Times Television
    • Spectrum News
    • The Newark Star-Ledger
    • The United Nations
    • McGraw/Hill
    • Oyster Yachts
    • Scottish Environmental Protection Agency
  • The Power of Storytelling
  • Why iPhones?
  • Michael on Media
  • Books
  • Contact

RE-INVENTING THE TELEVISION NEWS BUSINESS*

A revolution in video storytelling

Creating entirely new & cost-effective production methods

From the world leaders in video production training and the creators of Character Driven Storytelling™

*and every other business that uses video

WHAT WE DO

Over the past 35 years, we have designed, built or restructured some of the most powerful news and journalism companies in the world.

We replace the traditional TV news ‘crew’ with one highly trained journalist, working alone with nothing but an iPhone.

No more TV news ‘crews’, no editors and no field producers.

This is television news done the way newspaper journalism is done – one reporter with their electronic pad and pencil.

In doing this, we can cut the cost of production by as much as 75% while increasing ratings and audience engagement.

In the place of conventional TV news ‘packages’ – ie, reporter stand up, interview, b-roll, man on the street, we marry great journalism with Netflix and Hollywood storytelling.

It’s a combination that works.

We have taken most of our clients to #1 in their respective markets.

And it’s not just for news. Any company, any profit, any NGO and anyone else who is online needs to tell their story in compelling yet cost-effective video. We can teach you to do that. Either in person or virtually.

EXAMPLES OF WHAT WE CAN TEACH YOUR STAFF TO PRODUCE

ITAY HOD

Itay Hod, MMJ with KPIX/CBS in San Francisco, took the 5-Day Intensive Video Storytelling Bootcamp in 2018.

Because he works alone, with only an iPhone, he was able to embed himself with a homeless family.

Here’s the story he produced in a one-day turn.

KIET DO

Kiet Do, an MMJ with KPIX/CBS in San Francisco, took the 5-Day Intensive Video Storytelling Bootcamp in 2021.

Here is a story he produced, all on his own, with only an iPhone and in a one-day turn.

TAYLOR SCHAUB

Taylor Schaub, an MMJ with Spectrum News 1 in LA, took the 5-Day Intensive Video Storytelling Bootcamp in 2023.

Here is a story he turned in only one day, using only an iPhone. It was the first video story he ever did and it was nominated for an Emmy.

THE BOOTCAMP

How do we convert stations and whole networks to working in this way?

Since 1988, we have run intensive 5-Day Video Storytelling Bootcamps

We have done these all over the world.

These are hands-on bootcamps, and participants learn an entirely new way of creating TV news stories.

-We shoot at a 3:1 ratio or lower, so turnaround times are fast.

-We go directly from camera to timelilne and edit – no written scripts.  We work in the medium of pictures and sound.

-We are entirely character-driven.

-We are driven by pictures and real events.

-We are focused almost entirely on ’the viewer experience’.

Since 1988, more than 70,000 journalists around the world have taken our bootcamps, either in person on virtualy.

Case Studies

CBS Case Study Logos
CBS News

We have started to work with CBS News, bringing our ideas of character-driven storytelling to one of the most successful and biggest networks in the United States. Since beginning to work with them ratings have climbed and more importantly, audience engagement is through the ceiling.

Learn More
NYT Case Study Logos
New York Times Television

We started New York Times Television in 1990 and it was the first paper to be brought into the world of TV. It quickly became one of the most successful non-fiction production companies in the United States. The series and documentaries we produced won many awards including multiple Emmys.

Learn More
BBC Case Study Logos
The BBC

We have been working with the BBC since the year 2000 helping to convert their national news network to our visual storytelling technique. Most recently we have trained teams from their sports, documentaries, and comedy divisions to make character-driven stories using only smartphones.

Learn More
Spectrum Case Study Logos
Spectrum News

For the past five years we have worked with Spectrum News to introduce and train their journalists on visual, character driven storytelling using smartphones helping to create a different kind of local news for their network of 24-Hour News Stations across the United States.

Learn More
UN Case Study Logos
The United Nations

In 2006, we were approached by the United Nations. Rather than rely on news outlets, it would be much easier to train the field operatives to produce their own stories. We spent two years working with the UN, training more than 100 of their staff in bootcamps in Geneva and Nairobi.

Learn More
Star Ledger Case Study Logos
The Newark Star-Ledger

We trained 50 print reporters at the paper to shoot and tell their own stories, in conjunction with their print work. We built a TV newsroom in their existing print newsroom – you could not ask for a better set and they began to live stream their stories in conjunction with their print work.

Learn More
Mcgraw Hill Case Study Logos
Mcgraw Hill

We spent two years with McGraw Hill, training more than 150 of their staffers, making them completely video literate. McGraw/Hill media properties we transit included Business Week, Aviation Week, (what was the name of the architecture magazine), and JD Power and Associates.

Learn More
VOA Case Study Logos
Voice of America

In 1990, we were approached by The Voice of America, the official broadcasting agency for the United States Government. When we met with VOA, they were only a short wave radio broadcaster, but working with them, we took them into television, launching VOA-TV.

Learn More
Oyster Case Study Logos
Oyster Yachts

British based Oyster Yachts makes some of the finest yachts in the world. Like every other company, they had to find a way to feed the never-ending video demands of social media – sites like Instagram and TikTok. We trained the Oyster staff to tell their own stories, using only iPhones.

Learn More
SEPA Case Study Logos
Scottish Environmental Protection Agency

We were approached by SEPA, the Scottish Environmental Protection Agency because they had to continually find a way to ‘feed the media beast’. The result was that SEPA was able to tell their own stories, whenever they wanted, and at almost no additional cost.

Learn More
Image 11-11-22 at 6.25 PM

Michael on Media

Michael Rosenblum has been writing about the media since 1988. His work and ideas have appeared in The Guardian, The Huffington Post, Ilkeston Life and many other publications.

He has been blogging regularly for the past 35 years on this subject. Having taught media studies at Columbia University, NYU and now the University of Oxford, he is considered an expert on this subject.

Continue reading this post or look back at previous posts.

Read More

Do You Have Questions About Learning Video Skills?

If you would like to know more about our courses contact us and one of our training advisors will be happy to call you.

Contact Us

Copyright 2024. All rights reserved.