vBulletin Mods

Description:

OneSignal has an API that allows us to send unlimited web and push notifications for FREE. When I came to know about it, I spent several days and months searching for compatible plugins for vB4. Finally decided to learn and create my own based on pierce's similar mod for Xenforo.

Push notifications is a great way to keep your members engaged. It keeps driving them back to your site. This mod works great on mobile browsers as well.

This is the lite version which allows you to send web push notifications to your users whenever:

1. someone replies on their subscribed threads
2. sends them a PM
3. likes one of their posts (dbtech thanks)

Installation:

1. Register an account at OneSignal.com

   • Click on Add a new app to register your forum there
   • Select Web Push as the platform
     https://www.vbulletin.org/forum/external/2018/07/4.png
   • Configure Web Push by selecting Typical Site and enter you forum details
     https://www.vbulletin.org/forum/external/2018/07/5.png
   • Add at least one prompt and complete the remaining setup there. Leave most of the options as default. Only change where necessary.
   • After you click Save, you will get a few files to download.
     https://www.vbulletin.org/forum/external/2018/07/6.png
   • Download those files, extract them and upload them to your forum's root directory.
   • There is another section on the same page asking you to add code to your site. DO NOT add that code yet. It is automatically done when you install this product.

2. Download attached zip file. Upload the file functions_OneSignal.php under /includes directory
3. Install the product using the xml file
4. Go back to onesignal.com, under settings, click on Keys & IDs.
   https://www.vbulletin.org/forum/external/2018/07/7.png
5. Copy these keys and paste them in the settings in admincp.
   https://www.vbulletin.org/forum/external/2018/07/8.png

Disclaimer:
I am not associated with onesignal in any way. This is just something that I found useful for my forum and wanted to share with everyone else.

If I get enough support then I plan to add notifications for moderators' actions and for quotes and tags as well.


Download latest version: 1.3.5
If upgrading from previous version, replace the functions file as well.

Change log:
1.3.5 - Typo fixed
1.3.0 - Separated multiple consecutive notifications for different threads
1.2.0 - Added privacy for replies in private sections and
Subscribe button at the end of posts
1.1.0 - Fixed issue with sub-forum
1.0.1 - Fixed Table Prefix bug
1.0.0 - Initial Release

Screenshots:

This looks extremely interesting

Glad you liked it. Screenshots are added in the above post.

something that I noticed is that the server load spikes when this is active - testing more

How big is your forum and how many users are active simultaneously?

looking forward to testing this, not sure when i will be able to, but the other mod like this i tried had some fatal conflicts somewhere with other mods or whatever i was using.

i can't say with certainty that my load spike is your mod. I'll watch it though

Good afternoon.
I installed the mod, did everything according to the instructions, notifications come only from the themes of one forum, from other forums it comes only to e-mail. What could be the problem? Thank you!

sends notifications only from the topic, in English. Of those in the Russian language does not send. How to solve a problem? Thank you!

Even if the topic name in English, and the text of the response in Russian, the notification is not sent.

I am not sure why it doesn't work for Russian. Can you check your OneSignal control panel for message logs and see if there is any error listed there?

I have tested this with another language and it worked fine for me without any issues.

thanks for the answer.
if I send test messages from the OneSign panel, there are no errors. When I create a topic on the forum, the name in English, I write in it in English, there are no problems, push message comes. I think that the error with the processing of php mod ... or the encoding does not understand. I do not see any errors in the logs. And I tried to translate phrases in a php file, for example, "replied to", immediately ceases to send push messages.

and perhaps when sending push to convert the encoding cp1251 to utf-8? I see that the problem is this. Thank you.

And can I make it so that a notification without nicknames, topic names and messages is sent? The usual notification is a "new answer", or "a new personal message". And click on the link to send a link to a topic or personal message.
That would be the right decision! Moreover, I have a very small notice on the 27 "screen, and it's easier for me to click and read on the site." It's also more convenient for me to follow the link on a mobile phone.

Hi, I've followed your instructions exactly, but notifications to subscribe are not showing.
I'm just running a test board at the moment to see the capabilities of the software and it is located at

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

In the settings on OneSignal it does not allow me to enter that location, only

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

- could this be the reason it isn't showing?
Thanks.


Update:
Sorry I was being impatient. It's showing now, but as my connection is private it's blocking notifications. I'll see how it runs for other people though, thanks for providing this plugin.

Replace the file includes/functions_OneSignal.php with the attached file. You can even open that file in a text editor and modify the messages as you like.

:up: Yes! working!!!
PM removed from the code?
I change the text in the script if the English language works, if the Russian text does not send messages. I do not understand the problem.

and the transition from push notification to the wrong place where the new answer, but simply to the home page.

No, PM is not removed. It is there at line # 51.

https://www.carhelp.info/showthread....aign=onesignal Here such link comes in push, I think the end superfluous?

ok!


and this is a link where you had to switch by click to push.
https://www.carhelp.info/forums/show...87#post1544887

If you are using this you may want to take a look here - https://xenforo.com/community/thread...e-this.153212/

IMO there are GDPR implications.

in the delivery report in onesignal if you look there writes here such
Filters {"key":"uid","field":"tag","value":"10234362","relation":"="}
all links in notifications have the wrong view. How to fix it? Thank you!

your mobile phone transmits a lot more personal data.

in the settings of the service configured not to open in a new tab, but to switch to the tab if it is open in the browser. still open a new tab. I do not understand why.

Check your forum url settings in Admincp -> Settings -> Options -> Site Name / URL / Contact Details
https://www.carhelp.info/forums/admi...ogroup=address

Have you entered the correct url for your forum there?

This is something which cannot be controlled from this add-on. It can only be configured from OneSignal.

The end part is for Google Analytics. If you use analytics, then you can easily check how many users clicked on the notification and visited your forum.

Yes, it's all true. links to e-mail come correct.



probably because of the incorrect links, there on the service I set everything correctly.

I do not have such settings anywhere.
but the question is why the link to push notification comes here is this:

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

but here is the email:

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

a link to the email opens a topic or a PM, and the link from the push notification opens first 404 and then goes to the main page of the forum.

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

???

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

I have modified the attached file once again for your forum. Try it and let me know if it works.

The sub-folder link for your forum is hard-coded in the links.

Thank you! Now goes into the topic and to the PM!
when you go to the topic, opens the page you want, but you need to scroll the page to the post. If there are ideas how to correct I will be very grateful!

:up::up::up:

Hello.
Recently, I install this fantastic mod, but I don't sure if work correct.
Appears the icon, push in the icon notification and appears: Subscribe to notifications.
Ok, but if push again, appears the same (not for disable notifications, for example). This work like indicate?

Thanks and regards!

Notification not works in 3.8x i already reply there

Since I installed in vb 4.2.5 I received notifications (by forum) for new threads and pm, but onesignal not indicate, not push notification with this mod.
I don't know what happens, because, I don't have any error...

Regards.

Hi, my problem was solved.
I upload the files that we download of onesignal in my forum directory (my site its: www.mydomain.com/forum) and upload the files of onesignal in /forum folder.
Error, I upload to root folder (public_html) and now, yes, work fine.

Regards.

Thanks for the feedback. I will try add it in the next update.


When you click on the bell again, it shows the unsubscribe button, like this:


Thank you for the confirmation.

Yes, after upload the files of onesign to root folder (not to the folder of forum) now, appears like you indicate, if click in the bell again, now, shows the unsusbscribe button, now, work fine :)
But after this change, I have replys in suscribe threads but not have notifications in this bell.
Thanks and regards!

Hello.
I continue with the tests, like indicate in last reply, yes, now when I click on the bell again, it shows the unsubscribe button like you image, appears work fine.
But when I have new reply on one thread or quoted, I don't received any notification in this bell.
I received notification in browser but I think this is because, also, I have installed Advanced User Tagging

But the bull not indicate any notification.

Thanks and regards.

If you get notification as shown in screenshot in post #2
https://vbulletin.org/forum/showpost...89&postcount=2 then it is working fine.
The notifications are not inside the bell. It is actually browser notification. On desktop as well as on smartphone.

Hi iA1,
Yes, I received notification as shown in the screenshot of post 2 of the link that you indicate, then, its working fine.
I was think that, the notification is in the bell (I don't know for what reasson I was think this).

The notifications like your screenshot appears well.

Like Advanced User Tagging also have Desktop Notifications, I was think wrong about bell notifications.

Thank you very much for your detailed and attention reply.

Again, thank you very much!!

i install the product from two days and till now i don't get any automatic notification ,

N.B i add Keys & IDs. to the product , also i can send notification manually from OneSignal website and run vBulletin® Version 4.2.5

To get support, please mark as installed and send the link of your forum by PM.

Today, I view I have the same problem:
Also, My forum ints a: https://www.myforum.com/foro
But in the settings on OneSignal, I can't add /forum, only https://www.myforum.com
Made the same changes for solved?

Thanks and regards!

I have updated the plugin and applied a fix. Now it should work without any problems on forums that are on a sub-directory.

Download updated files, re-upload functions file under includes folder and re-install the product.

Thank you very much iA1! I download and re upload and re install the product.

Again, thanks!!!

This has been corrected in the previous update, 1.1.0

Update:

1.2.0 - Added privacy for replies in private sections.
Post content and thread title from private sections will not be displayed on push notifications. Instead, it just asks the recipient to click to view the post.

Added subscribe button after the last posts, before quick-reply box. It will only display if you enable Custom Link Prompt in your OneSignal settings.

Many Thanks iA1 for help in private PM and your valuable advise , which i will share here as i guide for other

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

My questions is

after your advise , the web site visitors can now subscribe in OneSignal notifications
but when i check the website page source i found that OneSignal code only appear after i inter web site as i user and not appear if i am unregistered visitor , is that mean that only registered visitor can subscribe in the OneSignal notifications

also until now there is no notification send from my forum automatically , and must send notifications manually from https://onesignal.com

Thanks for your work!!!

Hello.
Just, after 2 minutos post my last reply (before post I was update this mod), one user reply a private thread.
I received the notification that: The user x has replied a private thread (in english and my forum is spanish :)) but click in the link and go to www.mydomain.com (my forum is in: www.mydomain.com/foro).

Edit: also, I try the new function: Added subscribe button after the last posts, before quick-reply box. It will only display if you enable Custom Link Prompt in your OneSignal settings.

I create a Custom Link Prompt in OneSignal settings, I try, appears before quick response, click in the link I go to page that appears:

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

The url that appears in my browser is:

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

But after this, the bell indicate that, I are suscribed.

Regards and Happy Christmas!!!

Yes, this plugin is only for logged-in members, because it only sends notification to members who are subscribed to a thread.

I have not added the functionality to send push notifications to guest users.

To test working, subscribe a thread and ask someone to reply on it. Or ask someone to send you a PM. You can also send me a test user account by PM.

I will try to add phrases in the next update. For now, go to Plugin Manager in admincp and edit the plugin named 'Send newpost notification' under the product 'Web Push notifications using OneSignal'. You can edit the text in these two lines:
$extraData['title'] = 'a private thread';
$extraData['message'] = 'Click to view the post';

But make sure to enter only English characters. It does not accept special characters such as ñ.

There could be 2 reasons for seeing the invalid message:
- You were already subscribed
- You were not logged in

You can edit the custom buttom prompt in OneSignal settings and disable the button when a user is already subscribed, like this:
https://www.vbulletin.org/forum/external/2018/12/8.png

Ok, thanks iA1!

Yes, the custom buttom prompt in OneSignal I have configured for disable the button when a user is already subscribed.

I login with a user, unsuscrible, refresh my site, go to one thread, click in new option for subscribe (before quick reply) and again, I have the same error message.
But after this, the user are subscribed, appears in the bell and when I go to thread, not appears the option for subscribe.

Also, I view now that, all notifications when click, go to:

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

not the subforum folder

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

I need made some change in some file?

Again, thank you very much for your attention and help!

Happy Christmas!!!

We cannot actually control the button because that is generated by OneSignal itself. We are only able to change the place where this is shown to the user.

I noticed similar error when using incognito because the browser could not enable notifications.

This problem was already solved in previous update. Please test again.

many thanks , it work Now

but what if i want to also send push notifications to guest users , can i add the code manually or that will prevent the plug in from sending notifications about reply and PM to registered user

Sorry for the delay un reply, this christmas days...

Yes, confirm, I have the last version 1.2.0 and now, when I received a push notification, and click, send me to: www.mydomain.com
Not to www.mydomain.com/foro
And not send to the thread reply, or pm folder, only send me to www.mydomain.com

Regards.

You can send me the link to your forum by PM and a test user account to check.

You can add the code manually for guests as well but I do not recommend that. I tried it but found it problematic. If a subscribed user logs out, his userid will also be removed from OneSignal and he wont receive any notifications for PM or for his threads.

Thank you very very much!!!

Can you add options to automatically send notifications by new threads to all subscribed user using RSS feed

Hi there!

I'm testing your plugin, you did a good job!

thanks for sharing it with the community :)

All functionalities for me work well, except PUSH notifications when someone sends a PM to another user with the application installed.

Do you have any idea why PM notifications don't work?

Regards

Hi, I've finally been able to solve the problem.

I deleted line 116 from the file product-onesignal_notifications.xml

And it's worked.

Do you mean this line?
$contentType = 'pm';

or this line?
if ($vbulletin->options['iA1_onesignal_notif_active'])

this one -> if ($vbulletin->options['iA1_onesignal_notif_active'])

Deleted this code and only one time notification arrived. After the notification doesn't come when the PM arrives.

Update 1.3.0

Bug fixed for PM notifications
Separated multiple consecutive notifications from different threads

Thanks for your hard work!!

Onesignal never gave me files to download. All I got was the script to add in the header that the instructions say not to include. What did I miss?

If you didnt get the files I found them listed on the sites help page here.

https://documentation.onesignal.com/...-onesignal-sdk

I finally got it the 1st notification. Now to see if it keeps working.

Get this error when enabling this mod.

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

vBulletin 4.2.2 Patch Level 6 i use.

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

I get the error on the page.

Block Disabled:      (Update License Status)
Suspended or Unlicensed Members Cannot View Code.

I am getting this issue only in admin user.


---------------------------------------------------------------------

Also, I'm just going to notification in pm's. When quotes are made and other incidents do not go to the notification. I wonder if I'm missing something.

4.2.5 does not work, please help to check

YOu need to provide full details of the problem.

"does not work" says absolutely nothing that can be used to assist.

I installed this Mod into my vbb site also uploaded the OneSignal SDK files on the root directory of that site.
Then, in the Setiing page 'Web and Push Notifications using OneSignal'
I set Product Is Active: Yes
Provide OneSignal AppID, Authentication Key

But, I do not see any permission alert when I opened my vbb site on the Google Chrome browser.

At the footer I saw a copyright text Web Push Notifications by iA1.

Please give me a help ?

Please install the updated version 1.3.5. I found and fixed a typo in one of the plugins.

PM me your domain name and a test user account.

PM me your domain name and a test user account.

Where can i translate the notifications? Ive tried the "search phrases.

I cant get the notifications to work, my default language includes special characters. Is this the problem?

You will have to edit the file functions_OneSignal.php

I have not tested with special characters. Most probably they are not supported. I will try updating it later on.

What about vb 4.08 ?
I try to install but i get a blank page

On the top of the thread it states "vB Version: 4.2.x" which means they likely only tested it with vBulletin 4.2.* and not your version (which is extremely outdated, you should really upgrade)

Seems to be working well on 4.2.5
Cheers!

I have vb 4.2.5 and PHP 7.1 and works fine.

Would be good if there was a VB 5 version

I'm having some difficulties getting this to work, or I'm not understanding what it does.

I've signed up for an account at onesignal,
Entered my forum
https://www.caraudiocentral.net

downloaded the files
Uploaded the files to my forum root
https://www.caraudiocentral.net/forums

I then downloaded the plugin, uploaded the 1 file to the includes
and then installed the plugin.
Entered my Keys into the plugin settings
Enabled plugin.

I'm trying with my test accounts to get push notifications and nothing is happening.
I login with my main account on my forum, tried to PM my test account. No notification
Tried replying to a thread. No notification

Are there additional settings that need to be enabled?
Are there settings in the UserCP that a user needs to subscribe? I'm not seeing any but want to make sure.

My forum is running 4.2.5

Is it still enabled at your forum? I do not see the popup for subscribing. Try using the default style.

take a look now. It's odd, all of a sudden the little red bell just appeared.
I hadn't done anything since Friday.

I think it's working, when I reply to PMs from both accounts. I get a little popup lower right corner.

Thanks for the confirmation. Please mark as Installed.

You mention that this is "This is the lite version" Is there a pro?

Yes, this is lite version. I did not see much interest in getting a pro version from the users here, so did not complete the pro version until now. It is almost half done only and I use it on my own forum.

Would be interested in know what additional functionality you have incorporated as this is something I have thought about over the years but never saw anything or commissioned to code it.

Thank you so much

So far I have enabled subscription for guest visitors as well (default was only for logged in users), push notifications for subscribed forums, notifications to all mods whenever there is a new moderated post or a thread. I have also planned to add notifications for user tags.

Any other feature suggestion is welcome.

This is awesome! Was hoping for a mod like this!
Do you know when this mod will be ready? What are you thinking for cost?

Trying to get this to work but not seeing any popup/subscribe notification.
PM sent...

The load is handled by OneSignal, so there's negligible impact on your own server.

An updated version is almost ready for release. I will try to finalize it within a few days.