module ICS Generator

[thausmann]

The module can generate basic ICS calendar strings and files.

Usage Example:

$icsgen = wire()->modules->IcsGenerator;

// set properties
$icsgen->setArray(array(
  'date' => new \DateTime('2033-12-24 12:00'),
  'dateEnd' => new \DateTime('2033-12-24 13:00'),
  'summary' => 'Event title',
  'description' => 'Event description',
));

// get path to a temporary .ics file
// (using wire()->files->tempDir)
$icspath = $icsgen->getFile();

// send email with ics file
$mail = wireMail();
$mail->attachment($icspath, 'calendar.ics');
$mail->to($user->email);
$mail->subject('ICS Demo');
$mail->body('This is a ICS demo.');
$numSent = $mail->send();

For more infos see GitHub Readme or Modules Page. If you experience reproducable issues please open a GitHub issue.

[jploch]

Hi!
This is exactly what I need for a project I am working on.
But the module is not generating any files for me. Maybe I am doing something wrong?

Here is my code (testet locally on laravel valet and on a shared hosting server):

function icsLink() {
  $icsgen = wire()->modules->IcsGenerator;

  // set single properties (date strings)
  $icsgen->setArray(array(
    'date' => '2033-12-24 12:00',
    'dateEnd' => '2033-12-24 14:00',
    'summary' => 'Event title',
    'description' => 'Event description',
  ));

  $icsPath = $icsgen->getFile();

  $out = '<a href="' . $icsPath . '">Merken</a>';

  return $out;
}

The function returns the link successfully, but when I click the link I get a 404. While the link points to a file (site/assets/cache/WireTempDir/.icsgenerator/0/ics-1663226011-413791867.ics), it seems like the file is never created. Any ideas?

[thausmann]

Hey @jploch,

oh yes, getFile() only creates temporary files, they are deleted automatically when ProcessWire is done with the request. That may sounds weird, but my use case was to send ICS via E-Mail. 

To permanently store the file somewhere, I could imagine something like this:

// write ICS to a custom file
// https://processwire.com/api/ref/wire-file-tools/file-put-contents/
$str = $icsgen->getString();
$files->filePutContents('/my/server/path/event.ics', $str);

or

// add the temporary file to a file field (field named "ics_files")
// https://processwire.com/talk/topic/15928-adding-a-file-to-pagefiles-and-saving-to-database/
$path = $icsgen->getFile();
$page->of(false);
$page->ics_files->add($path);
$page->save('ics_files');

Both untested, let me know if this works.

[jploch]

@thausmann Thanks for your quick reply! 

This was very helpful! It seems like filePutContents works great, but you have to give it the full path:

    <?php
	//create ics file
    $icsgen = wire()->modules->IcsGenerator;
    $icsgen->set('date', '2033-12-24 12:00');
    $icsgen->set('dateEnd', '2033-12-24 14:00');
    $icsFileContent = $icsgen->getString();
    $icsFilePath = wire()->config->paths->assets.'files/'.$page->id.'/event.ics'; // use full path to create the file
    $icsFileUrl = wire()->config->urls->assets.'files/'.$page->id.'/event.ics'; // use relativ url to set the link target
    wire()->files->filePutContents($icsFilePath, $icsFileContent);
	?>
	
	<!-- Link to file -->
	<a href="<?= $icsFileUrl ?>">ICS File</a>

 

[Ralf]

@thausmann  I may have overlooked something, but is it possible to merge multiple events into ONE *.ics file with this module?

Or how would I have to draw a foreach loop to repeat the part from BEGIN:VENENT to END:VEVENT several times?

 

[Stefanowitsch]

This is great. I am just about to finish a project that deals with events. I will give it a try. 

[thausmann]

@Ralf Currently only one date per file is supported.

Multiple events seems to be possible with multiple VEVENTS. I'm not sure if I should add it, because as mentioned there, Outlook doesn't seem to handle it well.

Reoccuring events also come to mind, this should be easy to implement.

[Ralf]

@thausmann I can understand your reasoning and for individual dates that is fine.

But I have in a nonprofit association only the issue that until now just the complete events are output in a list and in addition again all dates are maintained in a Google calendar. The whole thing is always double work and leads to great joy for the people who are allowed to maintain it ...

Therefore I wanted to replace the Google calendar and not only create an output on the homepage from the data in Processwire but also offer a *.ics file.

With the "LAST-MODIFIED:" Specification (which I fill via the modified date of PW) the whole thing would then even still updateable!

Concerning the problems with Outlook I agree with you, this is not quite trivial but I solved it in such a way that a) I wanted a separate calendar in Outlook explicitly and b) I simply put a small instruction on the homepage, how one must proceed with Outlook integration.

Instructions for Outlook:
1. mark one of the links from above (ATTENTION please don't click on the link, otherwise the calendar will be opened in Outlook as a calendar snapshot, which will NOT be updated).
2. now click in Outlook in the menu Tools on Account Settings (from Outlook 2010 -> File - Details - Account Settings - Account Settings).
3. click on the tab Internet Calendar on New.
4. Paste the link into the field with a right click - Paste.
5. Click on Add.
6. Now enter the name of the calendar you want to display in Outlook in the Order name field and click OK.

Recurring events would also be a great addition, but in my current case I don't need them.

 

[thausmann]

@Ralf alright I'm on it. The new approach is a WireArray events property, that can hold data for one or more events. 

// get the module
$icsgen = wire()->modules->IcsGenerator;

// add an event
$icsgen->events->add([
    'summary' => 'Event Title 1',
    'description' => 'Event body 1',
    'dtstart' =>'2033-12-24 12:00',
    'dtend' => '2033-12-24 14:00',
]);

This is a breaking change, rest of the API stays the same.

Here is a working prototype so you can already test it if you like. I aim for a new version that also supports most ICS event properties like last-modified etc.

Edit: should be mostly done, just have to add some docs. Maybe someone can test it in Outlook.

Edited January 9, 2023 by thausmann

[e0f]

Hi all guys! And thanks for the job you made!

I have a question. I need a way to create 1 .ics for each user I have In ProcessWire, and when something happen (people confirm me dates etc) I want to append a VEVENT on the same .ics 

In this way the user have his link to .ics calendar and he can use it in sync outside (phone, os calendar, etc)

Can I do it with this module?

if yes, can someone share me some pseudo code to look in?

Thanks guys for your great job!

[Jan Romero]

Hi @e0f! Skimming the latest replies in this thread it sounds like that should be possible with @thausmann’s prototype version: https://github.com/timohausmann/IcsGenerator/tree/multievents

You can keep the .ics files around as static files that you only update when something changes (say, by hooking Pages::savedPageOrField) or you can just build them live for each request as you would any other page. Where do you want these files to live exactly?

If these calendars are supposed to be private to each user, you’ll need to figure out how to authenticate requests originating from your users’ calendar apps. That may or may not be the biggest hurdle in this endeavour, since they’re probably not going to send the session cookies ProcessWire normally uses.

Do you struggle with anything in particular?