Scheduling first node revision publishing

I started working on a patch for this. The patch is not yet complete. The UI is there for new nodes. But they are not being published on schedule yet.

Some parts of discussion with @merlinofchaos on IRC:

merlinofchaos: recidive: The UI I speak about is on the revisions tab -- i.e, node/%/revisions -- where we list the revisions and show which one is published. We also need to give them the ability to unpublish the current published revision there.
recidive: merlinofchaos: right, and this tab doesn't show up when there's only one revision
recidive: merlinofchaos: ok, I was looking for what prevent the revisions page to show up when there's only one revision
merlinofchaos: recidive: Oh that's probably the access callback on it
recidive: merlinofchaos: _node_revision_access ?
merlinofchaos: recidive: Probably yes. Would have to override that with one that will make sure revision access is available even with just one revision.

recidive: merlinofchaos: "set the draft revision current"
recidive: merlinofchaos: isn't this being done already?
merlinofchaos: recidive: In 99% of the cases yes.
merlinofchaos: recidive: But there's always some possibility that a prior revision is being edited and saved and that would change the current revision away from the draft revision.

merlinofchaos: recidive: One thing that bugs me here is that this gives us two different places on the node edit form where we might have the publish widget -- in the 'publication' section and in the 'revision' section.
recidive: merlinofchaos: I think it does make sense under "Publishing options"
recidive: merlinofchaos: The scheduler module adds a new tab
recidive: maybe we could add one to, e.g. "Scheduling"
recidive: merlinofchaos: and also options for the "published" checkbox, I'm not sure on this yet too
merlinofchaos: recidive: I was going to add a new tab but then it felt like it was extra weight.
merlinofchaos: recidive: I was thinking of maybe hiding the 'published' checkbox entirely.
recidive: merlinofchaos: so if date was left blank, it will be published or just be saved as draft?
merlinofchaos: recidive: If the box is checked and the date is blank, it'll be published immediately; if the box is unchecked, and there is no published draft (i.e, a new node) then it will be saved unpublished.
merlinofchaos: recidive: And if the box is checked and the date is in the future, it will be saved unpublished and then published on schedule.

merlinofchaos: I am also thinking we might want to not let users create unpublished entities if they won't have permission to view the entity when it's done. For nodes you need 'administer nodes' or 'view own unpublished content'

Here's an updated patch. Changing access callback to make it show the revions page when there's only one revision. Adding the 'supports_publishing_flag' but not using it yet.

Here's an updated patch.

• Moving form to a "Scheduling" vertical tab>
• Making sure a schedule is created for first revision
• Fixing code that set the status flag

Ok, I changed the access callback to the access switcher. New patch attached.

For the settings form for disbling this feature, where should we put that, any ideas?

Thanks for having the time to review the patch.

Re-rolled the patch.

I've found a problem when adding a node and checking the "Publish draft" but not entering a date. In this case date is set to time() so a schedule isn't created and the set_published_revision_current() method isn't called. I tried fixing this by overriding the update_entity_schedule() method, since this is where the scheduling bypass happen, couldn't get it to work yet. Here's what I added:

  public function update_entity_schedule($entity, $publish_date, $revision_id) {
    parent::update_entity_schedule($entity, $publish_date, $revision_id);

    // This will run when saving a node marked to be published and $publish_date
    // is empty or a past date.
    if ($publish_date <= time()) {
      $entity->status = !empty($entity->published_revision_id);
    }
  }

We need to figure out how to best change the status flag in this situation.

Re-rolled patch attached.

Fixed the problem with publishing immediately on node insert. I ended up overriding the hook_entity_insert() on ERSEntityNode like this:

  public function hook_entity_insert($entity) {
    parent::hook_entity_insert($entity);

    // When inserting a node, checking the "Publish draft" checkbox and not
    // entering a date, no schedule is created and
    // set_published_revision_current() doesn't get called, so we need to call
    // it here to make sure node status flag is set to TRUE.
    if (!empty($entity->published_revision_id) && empty($entity->status)) {
      $this->set_published_revision_current($entity->nid, $entity);
    }
  }

I wonder if the logic here shouldn't be on ERSEntityDefault hook_entity_insert() implementation instead.

Updated patch moving the changes in #13 from ERSEntityNode to ERSEntityDefault. As discussed with @merliofchaos in IRC, we don't need to check for support for published flag, since there's no default implementation for set_published_revision_current(). Also it may be good to give other handlers the opportunity to do other stuff in set_published_revision_current().

Here's what still needs to be done:

1. Make operations show up for first revision on revisions table.
2. Add an operation "unpublish" to revisions table
3. Add setting for disabling scheduling first node revision completely.

Task #1 seems pretty straightforward, #2 need to decide where to implement this, on base plugin or node specific, we can show this operation only if it supports published flag, #3 need some guidance on how to override/alter ERS settings form, or to know where else to put this.

Ok, I will have another crack at this tomorrow:

Here's the list of things that needs to be done:

• Make operations show up for first revision on revisions table.
• Add an operation "unpublish" to revisions table
• Make sure "Publish draft" checkbox is checked if node type defaults to "published" in content type settings.
• Fix a bug which is making the first revision published after adding a draft (that was regression introduced when changing the set_published_revision_current() to the base class).

Here an improved patch, adding options to node type settings form for publishing new nodes and drafts by default.

Also added 'unpublish' operation to revisions table.

We still need to figure out how to make this code run only when the node is first inserted:

      // When publishing a revision immediately after inserting the entity
      // set_published_revision_current() doesn't get called, so we need to call
      // it here to make sure entity types do what they need to do in this method.
      if (!empty($entity->published_revision_id)) {
        $this->set_published_revision_current($entity_id, $entity);
      }

Here's a followup patch, with small fixes.

Also, attached are some screenshots for the node type settings and for the revisions table with unpublishing node feature.

Hi Paul, I'm not sure it's on the plans. But it's for sure something we think about from time to time.

@merlinofchaos, can answer this better.

BTW, have you tested my patch?

Thanks.

@merlinofchaos my last patch includes the unpublish link next to the published revision on revisions table.

I think scheduling the unpublishing is out of the scope for this issue.

Ok. Needs work then.

@Paul Kim Disney: No, I've not added back the "Publish" checkbox in "Publishing options". The screenshots I've sent above are from content type settings form.

It looks like you're describing ERS without my patch.

Updated patch implementing UI for scheduling entity unpublishing. It's not fully working as some code needs to be added as well as schema changes in ers_schedule table needs to be made to also accomodate unpublishing schedule.

Should we use the same table for unpublishing schedules? I think it will need a new column 'action' that can be set to either 'publish' or 'unpublish' and also change the 'publish_date' field to just 'date'. Also the 'revision_id' field will be empty for unpublishing schedules, but that shouldn't be a problem.

Attached are two screenshots, one for the unpublish link on revisions table and other for the node editing form.

Here's an updated patch. Scheduling unpublishing is still broken. Need some help with this. The unpublishing schedule is being created on the revision page unpublish link, but not directly on node editing.

Edit: I'll be around tomorrow, to finish this.

Here's an updated patch making the unpublish scheduling stuff work. There's just some small tweaks on UI left to do which are:

1. making the unpublishing schedule show up on revisions table and
2. make the '#states' work for disabling the schedule form based on schedule selector.

Needs review of work so far.

New patch fixing the '#states' by adding a wrapper and a checkbox to trigger states.

Adding the unpublishing schedule to revisions table.

Here's a small follow up patch that fixes the indentation problem and remove a debugging call.

Here's another followup patch that fixes the following:

Fix some notices with UUID integration stuff.
Make scheduling first revision work again.
Make default values work again.
Make delete revision operation show up only if there are more then one revision.

I'm not quite happy with it, but the module is working better than without it.

Patch didn't get attached, due to validation error. Trying again.

New patch also fixes issue with scheduling drafts.