Add start and end times to schedule grid

that's a good idea.

that really needs to be stored as a setting rather than hard coded.

yeah as an admin configurable variable. the trick would be making it customizable enough that it'd work for your station which wants to hide the hours between 22:00 and 08:00 and my station which would hide them between 02:00 and 08:00. i think the way to handle it would be, rather than excluding those times from the query, just omit them when displaying the schedule.

now regarding your patch there's a few things wrong:
- table names are quoted using {}, not fields
- db_query() returns a query result not a value. you'll need to use db_fetch_array(), db_fetch_object(), db_result().
- eh, well i can't really figure out what the rest is supposed to be doing

that's looking really good. i'll try to get it in in the next week or so.

hey could you take a look at this patch? i took your changes and incorporated them into some other fixes i was working on. it should be functionally the same thing i've just been trying to use clearer names.

Hi, i'm a bit of a novice, but trimming the schedule is also something i need to do. Can someone help me with regards applying the patch? Where do i put the patch code?

Also, another related fix that i need is to do with spanning. If i try and schedule a program on a Saturday night, say 10pm-3am, i recieve a warning telling me that my program must start before it finnishes. This must be because Sunday is before saturday on the schedule perhaps?

Cheers

***Also posted as a new issue***

I have applied the patch which trims the schedule. This has helped no end. However, we do live broadcasts from nightclubs which may start at 10pm and go on until 3am the next day.

All normal programs start at 6pm. So ideally, the 'day' will start at 6pm, and everything previous can by trimmed using the patch. However, with programs overrunning until 3am for example, the trimming patch doesn't really work.

Would it be possible, although technically incorrect, to have a day starting at 6pm and going through until 3am and calling it 'Tuesday' or whatever. Then 'Wednesday' starts at 6pm again.

I feel this would also solve the secondary problem i am having. I try to schedule a program on Saturday night, to finish at midnight, however i am told 'a program must begin before it can end'. Obviously, the schedule module doesn't take into account 'weeks', and therefore thinks that my program finishing at midnight on Sunday morning, is before Saturday (Sunday must be the first day if the week?).

But if a 'day' ran through until 3am anyway, this would solve both my problems perhaps?

Thanks in advance.

good catch, though i think the easiest way to handle it would be

// add 59 minutes to ensure that it's rounded up to the next hour.
$last_hour = station_time_from_minute($o->max + 59, 'G');

it's less efficient pushing everything through station_time_from_minute() but i'm very reluctant to spread the date handling code around. that function is well tested and bugs will be apparent in many spots instead of just one off.

i'm not sure exactly what version it was against but it should have the CVS IDs in the patch. i'll try to re-roll something before long.

marked http://drupal.org/node/128890 as a duplicate

(based on joachim's comment #17)

i don't really like the names of the new fields in {station_schedule}. i think i'd prefer just start and finish or perhaps start_hour and finish_hour. though i'm sort of thinking it might be good to store that value in minutes. that way we can share code with the schedule items start and finish times.

i'd really like to get the wrapping working before we commit half of this. i'm worried that it'll be complex enough that we end up un-doing some of this.

re-roll with some cleanups.

marked http://drupal.org/node/219649 as a duplicate.

Hi drewish,

could you please update this patch to work with the latest dev version? I tried to run it, but it fails in three places in station_schedule.module...

Markus

Hi Drewish,
has this patch been actually applied on HEAD or has the discussion and application been abbandoned?

This is the last issue why we are not using the system for our radio station yet - our station director does not like the idea of having user to see half of the schedule empty :)

Thanks,
Marcel

marco, per #26 it still has some issues. please feel free to test it out though.

I also tried this patch on the final version 5.x-2.0 and there are also 3 fails in station_schedule.module! This would be also a great feature for our radio station. I attached the file "station_schedule.module.rej" below for review.

Can a patch be made for the current build? I would really like to have my schedule trimmed. :)

Sorry, forgot to change the dropdown from 'critical' to 'normal'. Though it is pretty important for my overall table design. I would try to look at the old patch and make the changes to have it work with the new one, but I'm a kindergartner when it comes to PhP coding.

I want to bump this to the D6 version and get it fixed there then consider what to do with the D5 version.

Are you thinking of putting it directly into the dev module that you're working on for D6 (rather than a patch)? I have your most recent update and was looking through the code but as I'm not too weathered in php, I couldn't figure out which strings needed changing/additions.

Honestly what I'd really like to do is convert the weekly schedule into a view so that it can be modified by admins easily. Then it'd just be a matter of adjusting the filter to set the start and end of the day.

I agree, converting it into a view would be really useful for admins. I don't really understand what joachim was taking about as far as how things are handled at the tail end of the week, however.

Well, luckily, as of now, our station doesn't have any shows that runs past midnight, but that could always change. I guess if there was a way to cut out a chunk of time like, say, 2am to 7am for each day. Is this possible? That the table starts at 12am is what doesn't work. If the table started at, say, 7am and the 12am-6:59am time slots were pinned on to the end, that would be acceptable. Are any of these things remotely doable? Or would it involve completely changing how the module is run?

Poking around I found this site: http://www.rfcradio.com/schedule/ . I don't know that they're using php, and its a wordpress system rather than drupal, but maybe the webmaster has some insight? Their schedule drops off the after midnight stuff at the end rather than at the beginning.

These are all just thoughts. I look at php and, save for doing string searches to change little things when I know what I'm looking for, its all Greek to me. I'm here and eager to test whatever you come up with though!

joachim, i'm not sure it would really affect the possible lengths of the schedule unless we do some admin UI over hauling... which isn't to say it's not a good goal just that I think it's a bit more complex than it appears at first glance.

kelizabeth, it looks like that schedule is only one hour blocks so it wouldn't encounter this particular problem.

Is there a way to just hack the schedule module to the desired hours as a temporary fix? Tell me what lines I should be looking for and I'll play around with it myself. The site I'm working on has gone live (http://www.berkeleyliberationradio.net) and I'd like to get this thing at least temporarily looking the way I want it to while changes to the module get sorted out. Any direction is greatly appreciated. :)

Like, if there something one of the files in the station schedule view folder (e.g. station_schedule_handler_field_start_time, station_schedule_handler_sort_time) that I could change so the schedule spans 24 hours, but starts and ends at 7am? I feel like it shouldn't be a big change, but I'm awful at php.

I'm guessing this isn't in the D6 version yet.

Marked #516724: Schedule time boundaries as duplicate.
Though I feel bad doing that, considering there hasn't been a patch for seven months, and no discussion for a month.

Where did this get left? What might I be able to help with?

it's very important this patch! there is a hope to have this feature?

Subscribing, the patch must be implemented in module functionality!
Also any progress on a patch for D6?

Hacked schedule module & template

Drupal - 6.15
Station - beta 3

I recently launched http://www.ashevillefm.org, and we needed to change the schedule a little bit. I made most of the changes in the template, with a few edits to the module itself. All of my changes are commented.

Any feedback is appreciated.

Added to my template.php

/**
 * Schedule Display
 */

// this is the left column 'time'
function avlfm_station_schedule_hour($hour)
{  
  // get rid of the first 8 hours 
  if ($hour < 8) {
    $output = '';
  }
  // we want our schedule to go to 2am,
  // so append an extra couple of hours
  // to the last one
  elseif ($hour == 23)
  {
    $class = 'station-sch-box station-sch-hour';
    $height = 60;
    // 23 o'clock
    $output = "<div class='{$class}' style='height:{$height}px;'>";
    $output .= theme('station_hour', $hour * 60);
    $output .= "</div>\n";
    // 24 o'clock
    $output .= "<div class='{$class}' style='height:{$height}px;'>";
    $output .= theme('station_hour', ($hour + 1) * 60);
    $output .= "</div>\n";
    // 25 o'clock
    $output .= "<div class='{$class}' style='height:{$height}px;'>";
    $output .= theme('station_hour', ($hour + 2) * 60);
    $output .= "</div>\n";
  }
  else
  {
    // The default.  this is the normal action
    $class = 'station-sch-box station-sch-hour';
    $height = 60;
    $output = "<div class='{$class}' style='height:{$height}px;'>";
    $output .= theme('station_hour', $hour * 60);
    $output .= "</div>\n";
  }
  return $output;
}

// this is the unscheduled spacers between scheduled times
function avlfm_station_schedule_spacer($start, $finish) {
  $class = 'station-sch-box station-sch-unscheduled';
  $height = ($finish - $start);
  
  // 8 hours = 480 minutes.
  // remove spacers that are 480 or bigger
  if ($height >= 480)  
  {
    $height = $height - 480;
    $output = "<div class='{$class}' style='height:{$height}px;'>";
    $output .= "<span class='station-sch-time'>".theme('station_hour_range', $start, $finish) ."</span>";
    $output .= "</div>\n";
  }
  else
  {
    // normal sized spacers
    $output = "<div class='{$class}' style='height:{$height}px;'>";
    $output .= /*$start." -> ".$finish." = ".$height.*/"<span class='station-sch-time'>".theme('station_hour_range', $start, $finish) ."</span>";
    $output .= "</div>\n";
  }
  
  return $output;
}

// these are the scheduled items
function avlfm_station_schedule_item($start, $finish, $program)
{
  $class = 'station-sch-box station-sch-scheduled';
  $height = ($finish - $start);
  $link = url('node/'. $program->nid);

  $output = "<div class='{$class}' style='height: {$height}px;'>";
  $output .= "<a href='{$link}'><span class='station-sch-time'>". theme('station_hour_range', $start, $finish) ."</span>";
  $output .= '<span class="station-sch-title">'. check_plain($program->title) .'</span>';
  
  if (!empty($program->field_station_program_dj)) {
    $djs = array();
    foreach ($program->field_station_program_dj as $entry) {
      $user = user_load($entry);
      $content_profile = content_profile_load('profile', $user->uid);
      $djs[] .= $content_profile->title;
    }
    $output .= '<span class="station-sch-djs">'. check_plain(implode(', ', $djs)) .'</span>';
  }
  
  // if we have enough room, show the Archive link
  // we use a static link for the 'most recent archive'
  // of each program.  
  if ($height >= 60) {
    $output .= "<a class='archive' href='".$program->field_stream[0][url]."'>Listen</a>";
  }
  
  $output .= "</div>\n";
  return $output;
}

/**
 * These next three I copied from the module
 * just in case I needed them, but I don't
 * think i've changed anything. 
 */
function avlfm_station_schedule_form_streams($form) {
  $header = array(t('Name'), t('Description'), t('URLs'));
  foreach (element_children($form) as $key) {
    $row = array();
    $row[] = drupal_render($form[$key]['name']);
    $row[] = drupal_render($form[$key]['description']);
    $row[] = drupal_render($form[$key]['urls']);
    $rows[] = $row;
  }
  return theme('table', $header, $rows) . drupal_render($form);
}

function avlfm_station_schedule_daytime_range($element) {
  return theme('form_element', $element, $element['#children'] );
}

function avlfm_station_schedule_daytime($element) {
  return theme('form_element', $element, '<div class="container-inline">'. $element['#children'] .'</div>');
}

/******** end schedule *********/

The edits I made to the module. (station_schedule.module)

function station_schedule_load ~ line 404
The changes here allow for programs to last past midnight, and not show those programs in the next day.

/**
 * Implementation of hook_load().
 */
function station_schedule_load($node) {
  $schedule = array();
  // Use station_day_name() for the day ordering in case Sunday isn't the
  // first day of the week.
  foreach (station_day_name() as $day => $name) {
    $schedule[$day] = array();

    $start = $day * MINUTES_IN_DAY;
    $finish = $start + MINUTES_IN_DAY;
    $result = db_query('SELECT * FROM {station_schedule_item} i WHERE i.schedule_nid = %d AND i.finish > %d AND i.start < %d ORDER BY i.start', $node->nid, $start, $finish);
    
    
    while ($s = db_fetch_object($result)) {
      // If a show spans a day, limit its start and finish times to be with-in
      // the day.
      if ($s->start < $start) {
        $s->start = $start;
      }
      // jonathan: commented this out so it wouldn't cut off shows
      // that go past midnight
      //if ($s->finish > $finish) {
      //  $s->finish = $finish;
      //}
      // jonathan: don't want to show anything that starts at the beginning of the day
      if (($s->start == 1440)
        ||($s->start == 2880)
        ||($s->start == 4320)
        ||($s->start == 5760)
        ||($s->start == 7200)
        ||($s->start == 8640))
        {
          // do nothing
        } else {
         $schedule[$day][] = $s;
        }
    }
  }

  // Load the settings.
  $settings = db_fetch_array(db_query('SELECT increment, streams, unscheduled_message FROM {station_schedule} WHERE nid = %d', $node->nid));
  if (isset($settings['streams']) && $streams = unserialize($settings['streams'])) {
    $settings['streams'] = array();
    foreach ($streams as $key => $stream) {
      // Add in the M3U URL.
      $stream['m3u_url'] = file_create_url('station/'. $node->nid .'-'. $key .'.m3u');
      $settings['streams'][$key] = $stream;
    }
  }
  else {
    $settings['streams'] = array();
  }

  return array(
    'settings' => $settings,
    'schedule' => $schedule,
  );
}

function station_schedule_week_page ~ line 913
The changes here increase the minutes in a day by 120 (so it shows until 2am of each day) and inserts spacers between two items that don't bump up. Not sure why I had to do it this way, but it seems to work for now.

  /**
 * Print a weekly schedule page.
 */
function station_schedule_week_page($node) {
  $header[0] = array('data' => t('Time'));
  $row = array();

  // First column is hours.
  $row[0] = array('id' => 'station-sch-hours', 'data' => '');
  for ($hour = 0; $hour < 24; $hour++) {
    $row[0]['data'] .= theme('station_schedule_hour', $hour);
  }

  // Then a column for each day of the week.
  foreach ((array) $node->schedule as $day => $items) {
    $header[$day + 1]['data'] = station_day_name($day);
    $row[$day + 1]['data'] = '';

    // The last finish pointer starts at the beginning of the day.
    $last_finish = $day * MINUTES_IN_DAY;
    $day_finish = (($day + 1) * MINUTES_IN_DAY) + 120; // jonathan: day finishes at 2am, so at 120 minutes
    foreach ($items as $item) {
      // Display blocks for unscheduled time periods
      /**
       * jonathan: insert a spacer if two items don't bump up.
       */ 
      if ($last_finish != $item->start) {
        $row[$day + 1]['data'] .= theme('station_schedule_spacer', $last_finish, $item->start);
      }
      /* end edits */
      // new last_finish
      $last_finish = $item->finish;

      // Display the schedule item.
      $program = node_load($item->program_nid);
      
      // theme the schedule item
      $row[$day + 1]['data'] .= theme('station_schedule_item', $item->start, $item->finish, $program);
    }
    // Display a block for any remaining time during the day.
    if ($last_finish < $day_finish) {
      $row[$day + 1]['data'] .= theme('station_schedule_spacer', $last_finish, $day_finish);
    }
  }

  // Add a class to indicate what day it is.
  $today = station_today();
  $header[$today + 1]['class'] = 'station-sch-now-day';
  $row[$today + 1]['class'] = 'station-sch-now-day';

  return theme('table', $header, array($row), array('id' => 'station-sch'));
}

Of course, any instances of 'avlfm' should be your theme name.

After doing all of this, I totally understand why an admin option isn't a simple patch.

Here's a patch to make the schedule start and end times configurable, based on parts of daggerhart's code from the previous comment, there.

I created the patch from the sites/all/modules/station/schedule directory, against the current HEAD version. It makes changes to station_schedule.install and station_schedule.module.

You need to run update.php after patching, because the patch changes the schema of the station_schedule table.

If this works properly, when you create or edit a Schedule node, you'll see two new fields, "Programming start time" and "Programming end time". They're in increments of 1 hour, because the way the schedule renders with the 1-hour-incremented left-hand "Time" column, I didn't think smaller increments would work. Here's a screenshot of the "Create Schedule" form: http://skitch.com/zoen/nhsxk/create-schedule-local.station-alteration

And a screenshot of a sample schedule, configured to show programs from 9pm to 4am: http://skitch.com/zoen/nhs1p/all-klezmer-all-the-time-local.station-alte...

The "Programming start time" field allows for start times between 00:00 and 23:00. "Programming end time" allows times between 01:00 and noon the next day. These time limitations, while useful for our needs, feel very arbitrary to me as part of a community tool, and I'm not sure what limitations to suggest... If anyone wants more time flexibility than this (eg, programming starting earlier than 00:00), talk about it and we'll cross that bridge etc etc. Oh, and I included some validation to prevent end times earlier than the start time.

Another thing people may want changed: the "Alter Schedule" table still goes from 00:00 to 24:00.

Just in case the patch doesn't work for you, I'm also including the altered versions of station_schedule.install and station_schedule.module.

I like where this is going but I'm not sure about station_schedule_hour_options(). Seems like we should probably use the schedule's increment to determine the intervals so the start and end times should be in minutes rather than hours. We can change the schedule themeing to round down to the previous hour.

ZoeN`s patch worked excellent for me! Thanks for this.

This functionality should be included into module for sure

@51 Bump.

I was halfway done a patch to implement the schedule's increments, and I think this patch makes more sense.

If the theme layer is going to be rounding down, that creates a disconnect between what the user selected and what they see. And without a complete overhaul, the schedule theming can't handle anything other than 60 minute increments. Also, I think sticking with hour-based increments makes more visual sense, regardless of the schedule's increment.

Rerolled against HEAD to apply from station instead of station/schedule. I'd say RTBC, but it's up to you drewish.

Worked on this more, couldn't come up with anything better, seems to work great.

Final nit-picky review on my part.

start_time and end_time are okay names but since they're hours would start_hour and end_hour be more accurate?

I think the doxygen standard is two stars to open the comment: http://drupal.org/node/1354#general

+/*
+ * Returns an array of possible programming start and end times.
+ */

The case statement should have a return after the breaks: http://drupal.org/coding-standards#controlstruct

Same goes for the else if and else later:

} else if ($i == 12) {

So looking at:

+    $start_time = $settings['start_time'] * 60;
+    $start = $day * MINUTES_IN_DAY + $start_time;
+    $end_time = $settings['end_time'] * 60;
+    $finish = $day * MINUTES_IN_DAY + $end_time;

and

     // The last finish pointer starts at the beginning of the day.
-    $last_finish = $day * MINUTES_IN_DAY;
-    $day_finish = ($day + 1) * MINUTES_IN_DAY;
+    $last_finish = $day * MINUTES_IN_DAY + ($settings['start_time']*60);
+    $day_finish = (($day) * MINUTES_IN_DAY) + ($settings['end_time']*60);

it seems like they're in minutes... did that not get updated? Also need to have spaces around the multiple operator.

Good catches on the formatting, and a good point with the naming.

I don't understand your last comment. $day * MINUTES_IN_DAY results in minutes, and $settings['start_time'] * 60 also results in minutes (basically $hour * MINUTES_IN_HOUR). Anything wrong with that?

Ah, my misunderstanding from just reading the patch rather than the full context. I'd thought the result needed to be hours not minutes so the * 60 seemed like an unnecessary operation. Looks great to me. A nice conclusion to a three-year-old issue.

Whew, that was a long standing issue. Thanks everyone, committed to HEAD!