pjs/webtools/litmus/Litmus/FormWidget.pm

# -*- mode: cperl; c-basic-offset: 8; indent-tabs-mode: nil; -*-

=head1 COPYRIGHT

 # ***** BEGIN LICENSE BLOCK *****
 # Version: MPL 1.1
 #
 # The contents of this file are subject to the Mozilla Public License
 # Version 1.1 (the "License"); you may not use this file except in
 # compliance with the License. You may obtain a copy of the License
 # at http://www.mozilla.org/MPL/
 #
 # Software distributed under the License is distributed on an "AS IS"
 # basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 # the License for the specific language governing rights and
 # limitations under the License.
 #
 # The Original Code is Litmus.
 #
 # The Initial Developer of the Original Code is
 # the Mozilla Corporation.
 # Portions created by the Initial Developer are Copyright (C) 2006
 # the Initial Developer. All Rights Reserved.
 #
 # Contributor(s):
 #   Chris Cooper <ccooper@deadsquid.com>
 #   Zach Lipton <zach@zachlipton.com>
 #
 # ***** END LICENSE BLOCK *****

=cut

package Litmus::FormWidget;
use strict;

BEGIN {
    use Exporter ();
    use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
    $VERSION     = 0.01;
    @ISA         = qw (Exporter);
    #Give a hoot don't pollute, do not export more than needed by default
    @EXPORT      = qw ( getProducts );
    @EXPORT_OK   = qw ();
    %EXPORT_TAGS = ();
}

use DBI;
use Litmus::DBI;

our $_dbh = Litmus::DBI->db_Main();

#########################################################################
=head1 NAME

Litmus::FormWidget - Create value lists to be used in HTML forms

=head1 SYNOPSIS

  use Litmus::FormWidget

=head1 DESCRIPTION

Litmus::FormWidget creates value lists to be used in HTML forms.

=head1 USAGE


=head1 BUGS



=head1 SUPPORT



=head1 AUTHOR

    Chris Cooper
    CPAN ID: CCOOPER
    Mozilla Corporation
    ccooper@deadsquid.com
    http://litmus.mozilla.org/

=head1 SEE ALSO

perl(1).

=cut

#########################################################################

#sub new
#{
#    my ($class, %parameters) = @_;
#    my $self = bless ({}, ref ($class) || $class);
#    return ($self);
#}

#########################################################################

=head2 getProducts

 Usage     : How to use this function/method
 Purpose   : What it does
 Returns   : What it returns
 Argument  : What it wants to know
 Throws    : Exceptions and other anomolies
 Comments  : This is a sample subroutine header.
           : It is polite to include more pod and fewer comments.

See Also   : 

=cut

#########################################################################
sub getProducts()
{
    my $sql = "SELECT DISTINCT(name) FROM products ORDER BY name";
    return _getValues($sql);
}

#########################################################################
sub getUniquePlatforms()
{
    my $sql = "SELECT DISTINCT(name) FROM platforms ORDER BY name";
    return _getValues($sql);
}

#########################################################################
sub getPlatforms()
{
    my $sql = "SELECT pl.name AS platform_name, pr.name AS product_name, pl.platform_id AS platform_id FROM platforms pl, products pr WHERE pl.product_id=pr.product_id ORDER BY pl.name, pr.name";
    return _getValues($sql);
}

#########################################################################
sub getBranches()
{
    my $sql = "SELECT DISTINCT(name) FROM branches ORDER BY name";
    return _getValues($sql);
}

#########################################################################
sub getOpsyses()
{
    my $sql = "SELECT DISTINCT(name) FROM opsyses ORDER BY name";
    return _getValues($sql);
}

#########################################################################
sub getLogTypes()
{
    my $sql = "SELECT DISTINCT(name) FROM log_type_lookup ORDER BY name";
    return _getValues($sql);
}

#########################################################################
sub getTestStatuses()
{
    my @TestStatuses = ({name => 'Enabled'},
                        {name => 'Disabled'});
    return \@TestStatuses;
}

#########################################################################
sub getResultStatuses()
{
    my $sql = "SELECT result_status_id,class_name FROM test_result_status_lookup ORDER BY result_status_id";
    return _getValues($sql);
}

#########################################################################
sub getTestGroups()
{
    my $sql = "SELECT DISTINCT(name) FROM test_groups ORDER BY name";
    return _getValues($sql);
}

#########################################################################
sub getTestIDs()
{
    my $sql = "SELECT test_id FROM tests ORDER BY test_id";
    return _getValues($sql);
}

#########################################################################
sub getLocales()
{
  my @locales = Litmus::DB::Locale->retrieve_all(
                                                 { order_by => 'abbrev' }
                                                );
  return \@locales;
}

#########################################################################
sub getUsers()
{
  my @users = Litmus::DB::User->retrieve_all(
                                             { order_by => 'email' }
                                            );
  return \@users;
}

#########################################################################
sub getFields()
{
    my @fields = (
                  { name => 'buildid',
                    display_string => "Build ID", },
                  { name => 'comment',
                    display_string => "Comments", }, 
                  { name => 'locale',
                    display_string => "Locale", }, 
                  { name => 'opsys',
                    display_string => "Operating System", }, 
                  { name => 'platform',
                    display_string => "Platform", }, 
                  { name => 'product',
                    display_string => "Product", },
                  { name => 'result_status',
                    display_string => "Result Status", },
                  { name => 'subgroup',
                    display_string => "Subgroup", },
                  { name => 'email',
                    display_string => "Submitted By", },
                  { name => 'summary',
                    display_string => "Summary", }, 
                  { name => 'test_group',
                    display_string => "Testgroup", },
                  { name => 'user_agent',
                    display_string => "User Agent", },
                  );
    return \@fields;
}

#########################################################################
sub getMatchCriteria()
{
    my @match_criteria = (
                          { name => "contains_all",
                            display_string => "contains all of the words/strings" },
                          { name => "contains_any",
                            display_string => "contains any of the words/strings" },
                          { name => "contains",
                            display_string => "contains the word/string" },
                          { name => "contains_case",
                            display_string => "contains the word/string (exact case)" },
                          { name => "not_contain",
                            display_string => "does not contains the word/string" },
                          { name => "not_contain_any",
                            display_string => "does not contains any of the words/string" },
                          { name => "regexp",
                            display_string => "matches the regexp" },
                          { name => "not_regexp",
                            display_string => "does not match the regexp" },
                          );
    return \@match_criteria;
}

#########################################################################
sub getSortFields()
{
    my @sort_fields = (
                       { name => "branch", 
                         display_string => "Branch"},
                       { name => "created", 
                         display_string => "Date"},
                       { name => "locale", 
                         display_string => "Locale"},
                       { name => "platform", 
                         display_string => "Platform"},
                       { name => "product", 
                         display_string => "Product"},
                       { name => "email", 
                         display_string => "Submitted By"},
                       { name => "summary", 
                         display_string => "Summary"},
                       { name => "result_status", 
                         display_string => "Status"},
                       { name => "test_id", 
                         display_string => "Testcase ID#"},
                       { name => "test_group", 
                         display_string => "Testgroup"},
                       );
    return \@sort_fields;
}

#########################################################################
sub _getValues($)
{
    my ($sql) = @_;
    my $sth = $_dbh->prepare_cached($sql);
    $sth->execute();
    my @rows;
    while (my $data = $sth->fetchrow_hashref) {
    push @rows, $data;
    }
    return \@rows;
}

1;