405 lines
12 KiB
Perl
405 lines
12 KiB
Perl
package WebGUI::Asset::Wobject::StockData;
|
|
|
|
#-------------------------------------------------------------------
|
|
# WebGUI is Copyright 2001-2009 Plain Black Corporation.
|
|
#-------------------------------------------------------------------
|
|
# Please read the legal notices (docs/legal.txt) and the license
|
|
# (docs/license.txt) that came with this distribution before using
|
|
# this software.
|
|
#-------------------------------------------------------------------
|
|
# http://www.plainblack.com info@plainblack.com
|
|
#-------------------------------------------------------------------
|
|
|
|
use strict;
|
|
use WebGUI::International;
|
|
use WebGUI::Asset::Wobject;
|
|
use Finance::Quote;
|
|
use Tie::IxHash;
|
|
use Number::Format ();
|
|
|
|
use Moose;
|
|
use WebGUI::Definition::Asset;
|
|
extends 'WebGUI::Asset::Wobject';
|
|
define tableName => 'StockData';
|
|
define icon => 'stockData.gif';
|
|
define assetName => ["assetName", 'Asset_StockData'];
|
|
property templateId => (
|
|
fieldType => "template",
|
|
default => 'StockDataTMPL000000001',
|
|
tab => 'display',
|
|
namespace => 'StockData',
|
|
label => ["template_label", 'Asset_StockData'],
|
|
hoverHelp => ["template_label_description", 'Asset_StockData'],
|
|
);
|
|
property displayTemplateId => (
|
|
fieldType => "template",
|
|
default => 'StockDataTMPL000000002',
|
|
tab => 'display',
|
|
namespace => "StockData/Display",
|
|
label => ["display_template_label", 'Asset_StockData'],
|
|
hoverHelp => ["display_template_label_description", 'Asset_StockData'],
|
|
);
|
|
property defaultStocks => (
|
|
fieldType => "textarea",
|
|
default => "DELL\nMSFT\nORCL\nSUNW\nYHOO",
|
|
tab => 'properties',
|
|
label => ["default_stock_label", 'Asset_StockData'],
|
|
hoverHelp => ["default_stock_label_description", 'Asset_StockData'],
|
|
);
|
|
property source => (
|
|
fieldType => "selectList",
|
|
default => "usa",
|
|
tab => 'properties',
|
|
options => &_getStockSources,
|
|
label => ["stock_source", 'Asset_StockData'],
|
|
hoverHelp => ["stock_source_description", 'Asset_StockData'],
|
|
);
|
|
property failover => (
|
|
fieldType => "yesNo",
|
|
default => undef,
|
|
label => ["failover_label", 'Asset_StockData'],
|
|
hoverHelp => ["failover_description", 'Asset_StockData'],
|
|
);
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _appendStockVars ( hash, data, symbol )
|
|
|
|
Appends stock variables for the symbol passed in to the hash passed in
|
|
|
|
=head3 hash
|
|
|
|
hash to append stock variables to
|
|
|
|
=head3 data
|
|
|
|
hash reference in the format passed by the fetch method from Finance::Quote
|
|
|
|
=head3 symbol
|
|
|
|
stock symbol to append variables for
|
|
|
|
=cut
|
|
|
|
sub _appendStockVars {
|
|
my $self = shift;
|
|
my $hash = $_[0];
|
|
my $data = $_[1];
|
|
my $symbol = $_[2];
|
|
$hash->{'stocks.symbol'} = _na($symbol);
|
|
$hash->{'stocks.name'} = _na($data->{$symbol,"name"});
|
|
$hash->{'stocks.last'} = _na($data->{$symbol,"last"});
|
|
$hash->{'stocks.high'} = _na($data->{$symbol,"high"});
|
|
$hash->{'stocks.low'} = _na($data->{$symbol,"low"});
|
|
$hash->{'stocks.date'} = _na($data->{$symbol,"date"});
|
|
$hash->{'stocks.time'} = _na($data->{$symbol,"time"});
|
|
|
|
$hash->{'stocks.net'} = _na($data->{$symbol,"net"});
|
|
$hash->{'stocks.net.isDown'} = $hash->{'stocks.net'} < 0;
|
|
$hash->{'stocks.net.isUp'} = $hash->{'stocks.net'} > 0;
|
|
$hash->{'stocks.net.noChange'} = $hash->{'stocks.net'} == 0;
|
|
|
|
$hash->{'stocks.net.icon'} = "nc.gif";
|
|
if($hash->{'stocks.net.isDown'}) {
|
|
$hash->{'stocks.net.icon'} = "down.gif";
|
|
} elsif($hash->{'stocks.net.isUp'}) {
|
|
$hash->{'stocks.net.icon'} = "up.gif";
|
|
}
|
|
$hash->{'stocks.p_change'} = _na($data->{$symbol,"p_change"});
|
|
$hash->{'stocks.volume'} = _na($data->{$symbol,"volume"});
|
|
$hash->{'stocks.volume.millions'} = _na(sprintf('%.2f', $hash->{'stocks.volume'}/1000000));
|
|
$hash->{'stocks.avg_vol'} = _na($data->{$symbol,"avg_vol"});
|
|
$hash->{'stocks.bid'} = _na($data->{$symbol,"bid"});
|
|
$hash->{'stocks.ask'} = _na(Number::Format::format_number($data->{$symbol,"ask"}));
|
|
$hash->{'stocks.close'} = _na($data->{$symbol,"close"});
|
|
$hash->{'stocks.open'} = _na($data->{$symbol,"open"});
|
|
$hash->{'stocks.day_range'} = _na($data->{$symbol,"day_range"});
|
|
$hash->{'stocks.year_range'} = _na($data->{$symbol,"year_range"});
|
|
my ($yrLo,$yrHi) = split("-",$hash->{'stocks.year_range'});
|
|
|
|
$hash->{'stocks.year_high'} = _na($self->_trim($yrHi));
|
|
$hash->{'stocks.year_low'} = _na($self->_trim($yrLo));
|
|
$hash->{'stocks.eps'} = _na($data->{$symbol,"eps"});
|
|
$hash->{'stocks.pe'} = _na($data->{$symbol,"pe"});
|
|
$hash->{'stocks.div_date'} = _na($data->{$symbol,"div_date"});
|
|
$hash->{'stocks.div'} = _na($data->{$symbol,"div"});
|
|
$hash->{'stocks.div_yield'} = _na($data->{$symbol,"div_yield"});
|
|
$hash->{'stocks.cap'} = _na(lc($data->{$symbol,"cap"}));
|
|
$hash->{'stocks.ex_div'} = _na($data->{$symbol,"ex_div"});
|
|
$hash->{'stocks.nav'} = _na($data->{$symbol,"nav"});
|
|
$hash->{'stocks.yield'} = _na($data->{$symbol,"yield"});
|
|
$hash->{'stocks.exchange'} = _na($data->{$symbol,"exchange"});
|
|
$hash->{'stocks.success'} = _na($data->{$symbol,"success"});
|
|
$hash->{'stocks.errormsg'} = _na($data->{$symbol,"errormsg"});
|
|
$hash->{'stocks.method'} = _na($data->{$symbol,"method"});
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _na ( string )
|
|
|
|
If string passed in is empty, returns N/A
|
|
|
|
=head3 string
|
|
|
|
a string
|
|
|
|
=cut
|
|
|
|
sub _na {
|
|
my $str = $_[0];
|
|
unless($str) {
|
|
$str = "N/A";
|
|
}
|
|
return $str;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _appendZero( integer )
|
|
|
|
Appends a zero to an integer if it is 0-9
|
|
|
|
=head3 integer
|
|
|
|
an integer
|
|
|
|
=cut
|
|
|
|
sub _appendZero {
|
|
my $self = shift;
|
|
my $num = $_[0];
|
|
if (length($num) == 1) {
|
|
$num = "0".$num;
|
|
}
|
|
return $num;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _convertToEpoch ( date, time )
|
|
|
|
Converts the date and time returned by Finance::Quote to an epoch
|
|
|
|
=head3 date
|
|
|
|
date format returned by Finance::Quote
|
|
|
|
=head3 time
|
|
|
|
time format returned by Finance::Quote
|
|
|
|
=cut
|
|
|
|
sub _convertToEpoch {
|
|
my $self = shift;
|
|
my $date = $_[0];
|
|
my $time = $_[1];
|
|
|
|
unless ($date =~ m{^\d+/\d+/\d+} and $time =~ m{^\d+:\d+}) {
|
|
return undef;
|
|
}
|
|
|
|
my ($month,$day,$year) = split("/",$date);
|
|
$month = $self->_appendZero($month);
|
|
$day = $self->_appendZero($day);
|
|
my $tfixed = substr($time,0,-2);
|
|
my ($hour,$minute) = split(":",$tfixed);
|
|
if($time =~ m/pm/i) {
|
|
$hour += 12;
|
|
}
|
|
$hour = $self->_appendZero($hour);
|
|
$minute = $self->_appendZero($minute);
|
|
return $self->session->datetime->humanToEpoch("$year-$month-$day $hour:$minute:00");
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _getStocks ( stocks )
|
|
|
|
Private method which retrieves stock information from the Finance::Quote package
|
|
|
|
=head3 stocks
|
|
|
|
List of stock symbols to find passed in as an array reference. Stock symbols should all be uppercase.
|
|
|
|
=cut
|
|
|
|
sub _getStocks {
|
|
my $self = shift;
|
|
my $stocks = $_[0];
|
|
|
|
# Create a new Finance::Quote object
|
|
my $q = Finance::Quote->new;
|
|
# Disable failover if specified
|
|
unless ($self->failover) {
|
|
$q->failover(0);
|
|
}
|
|
|
|
# Hardcoded timeout for now.
|
|
$q->timeout(15);
|
|
|
|
# Fetch the stock information and return the results
|
|
return $q->fetch($self->source,@{$stocks});
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _getStockSources ( )
|
|
|
|
Class method which retrieves the list of available stock sources from
|
|
Finance::Quote package and returns the results as a hash reference for
|
|
the selectList Form API.
|
|
|
|
=cut
|
|
|
|
sub _getStockSources {
|
|
my $class = shift;
|
|
my @srcs = Finance::Quote->new->sources;
|
|
my %sources;
|
|
|
|
# Tie to IxHash to preserve alphabetical order
|
|
tie %sources, "Tie::IxHash";
|
|
foreach my $src (@srcs) {
|
|
$sources{$src} = $src;
|
|
}
|
|
|
|
return \%sources;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 _trim ( str )
|
|
|
|
Trims whitespace form front and end of a string
|
|
|
|
=head3 str
|
|
|
|
a string to trim
|
|
|
|
=cut
|
|
|
|
sub _trim {
|
|
my $self = shift;
|
|
my $str = $_[0];
|
|
$str =~ s/^\s//;
|
|
$str =~ s/\s$//;
|
|
return $str;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 prepareView ( )
|
|
|
|
See WebGUI::Asset::prepareView() for details.
|
|
|
|
=cut
|
|
|
|
sub prepareView {
|
|
my $self = shift;
|
|
$self->SUPER::prepareView();
|
|
my $template = WebGUI::Asset::Template->newById($self->session, $self->templateId);
|
|
if (!$template) {
|
|
WebGUI::Error::ObjectNotFound::Template->throw(
|
|
error => qq{Template not found},
|
|
templateId => $self->templateId,
|
|
assetId => $self->getId,
|
|
);
|
|
}
|
|
$template->prepare($self->getMetaDataAsTemplateVariables);
|
|
$self->{_viewTemplate} = $template;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 view ( )
|
|
|
|
method called by the www_view method. Returns a processed template
|
|
to be displayed within the page style
|
|
|
|
=cut
|
|
|
|
sub view {
|
|
my $self = shift;
|
|
my $var = {};
|
|
#Set some template variables
|
|
$var->{'extrasFolder'} = $self->session->url->extras("wobject/StockData");
|
|
$var->{'editUrl'} = $self->getUrl("func=editStocks");
|
|
$var->{'isVisitor'} = $self->session->user->userId eq 1;
|
|
$var->{'stock.display.url'} = $self->getUrl("func=displayStock;symbol=");
|
|
|
|
#Build list of stocks as an array
|
|
my $defaults = $self->defaultStocks;
|
|
#replace any windows newlines
|
|
$defaults =~ s/\r//;
|
|
my @array = split("\n",$defaults);
|
|
#trim default stocks of whitespace
|
|
for (my $i = 0; $i < scalar(@array); $i++) {
|
|
$array[$i] = $self->_trim($array[$i]);
|
|
}
|
|
my $data = $self->_getStocks(\@array);
|
|
|
|
my @stocks = ();
|
|
foreach my $symbol (@array) {
|
|
my $hash = {};
|
|
|
|
#Append Template Variables for stock symbol
|
|
$self->_appendStockVars($hash,$data,$symbol);
|
|
|
|
#Create last update date formats
|
|
unless ($var->{'lastUpdate.default'}) {
|
|
my $luEpoch = $self->_convertToEpoch($hash->{'stocks.date'},$hash->{'stocks.time'});
|
|
if (defined $luEpoch) {
|
|
@$var{'lastUpdate.intl', 'lastUpdate.us', 'lastUpdate.default'} =
|
|
map {$self->session->datetime->epochToHuman($luEpoch, $_)}
|
|
("%y-%m-%d %j:%n", "%m/%d/%y %h:%n %p", "%C %d %H:%n %P");
|
|
} else {
|
|
@$var{'lastUpdate.intl', 'lastUpdate.us', 'lastUpdate.default'} =
|
|
('(not available)') x 3;
|
|
}
|
|
}
|
|
|
|
push (@stocks, $hash);
|
|
}
|
|
$var->{'stocks.loop'} = \@stocks;
|
|
return $self->processTemplate($var, undef, $self->{_viewTemplate});
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 www_displayStock ( )
|
|
|
|
Web facing method which allows users to view details about their stocks
|
|
|
|
=cut
|
|
|
|
sub www_displayStock {
|
|
my $self = shift;
|
|
my $var = {};
|
|
return $self->session->privilege->noAccess() unless $self->canView();
|
|
|
|
$var->{'extrasFolder'} = $self->session->url->extras("wobject/StockData");
|
|
|
|
my $symbol = $self->session->form->process("symbol");
|
|
my $data = $self->_getStocks([$symbol]);
|
|
#Append Template Variables for stock symbol
|
|
$self->_appendStockVars($var,$data,$symbol);
|
|
|
|
#Configure last update dates
|
|
my $luEpoch = $self->_convertToEpoch($var->{'stocks.date'},$var->{'stocks.time'});
|
|
if (defined $luEpoch) {
|
|
@$var{'lastUpdate.intl', 'lastUpdate.us'} =
|
|
map {$self->session->datetime->epochToHuman($luEpoch, $_)}
|
|
("%y-%m-%d", "%m/%d/%y");
|
|
} else {
|
|
@$var{'lastUpdate.intl', 'lastUpdate.us'} =
|
|
('(not available)') x 2;
|
|
}
|
|
|
|
return $self->processTemplate($var, $self->displayTemplateId);
|
|
}
|
|
|
|
|
|
__PACKAGE__->meta->make_immutable;
|
|
1;
|