Magic - User System Framework

[Mentor]

Hey peoples,

As a by-product of procrastination I've begun work on an idea I had a while back, which was to develop a simple yet functional User System framework, to rapidly speed up development times when creating a dynamic site.

The system works by including a class within your page, providing an abstracted set of functions you can use to create a fully fledged user system.

Since this is still in the early development stages i wanted to know what features people think it would need.

NOTE: This is not a user system itself, but instead a framework to build user systems with.


So far:
Functions

authenticated()
- true / false as to whether user is logged in

getName()
- return username or guest if not logged in

getAvatar()
- get avatar url of user

login($username,$password)
- log user in

logout()
- log user out

getUserInfo($uid)
- Return array of users details

updateProfileField($field,$newvalue)
- updates profile feild

updateProfile($uid,$avatar,$description)
- Update profile info

createNewUser
- Create new user in the system

removeUser($id)
- remove user from system

changePassword($oldpassword,$newpassword)



Any other important, functions of features wanted. the system works both with flatfiles only or with a MySQL database :)

[Jaysun]

This is very good and will help a lot of people out, you should go ahead with it.

[iDenning]

Sounds good, go for it.

Cant think of any stuff, maybe a chatbox where you can discuss stuff? idno :)

[Jacobred]

Yeah, would be a great help as I find Habbosofts useless, firstly you cant intergrate it into your own website with massive coding and secondly more features!

[Blob]

smarty support? im sure you can extend the smarty class to add new functions into it? i dont know, but i think you can.

[Source]

Adding smarty would bloat the hell out of what I think should be a simple library to help build systems.

[Blob]

Adding smarty would bloat the hell out of what I think should be a simple library to help build systems.

no i meant a seperate class for smarty so you could do like

{loggedin="true"}
something
{/loggedin}

[Source]

Oh right, a class to set smarty up for basic usage of the user system. That could be beneficial.

[Mentor]

Smarty definaly looks like it could be a good choice for adding in as i was concidering writeing my own skinning engine :p
Im trying to write Magic so its highly abstracted enogth that the front end is almost completely customisable in how its impleneted. So far to use smarty the only change needed would be to import smarty along with the magic class's at the top of your page, but more direct intergration is definitly somthing to think about.

Anyway, i started creating a test script for it (ugly as hell) but shows how you would interact with the usersystem magic class so far. (i know its badly done but its mainly to demo the interactions and for me to test stuff on the fly)


<?php

//Magic!
include('Magic/userSys.php');
$userSys = new UserSystem('config.php');

//System,
$profile = $_GET['profile'];

?>
<div style='background-color:black;padding:10px;margin:0;color:#ffffff;fo nt-weight:bold;'>
<?php

if($userSys->authenticated()){
echo "Welcome back <a href='?profile=".$userSys->getUID()."'>".$userSys->getName().'</a> - - logout';
}else{
echo "Please Login";
}

?>
</div>

<div style='float:right;padding:5px;margin:15px;backgro und-color:black;color:white;width:200px;'>
<strong>Users List</strong> <br>
<?php

$userslist = $userSys->getUserList();
foreach($userslist as $username => $uid){
echo "<a href='?profile={$uid}'>{$username}</a><br>";
}
?>

</div>
<div style='padding:20px;'>
<?php
$user = $userSys->getUserInfo($profile);
if($user !==null){
$profile = $user->getAttributeArray();
foreach($profile as $att => $val){
echo $att.' : '.$val.' <br>';
}

}else{
echo 'invalid profile';
}


?>
</div>


Produces
http://img269.imageshack.us/img269/9919/quick.jpg

Any comments on how the userSys methods work?

[Source]

Havnt seen how the class is written but, wouldn't it make more sense to merge

$userSys->getUID()

and

$userSys->getName()

into something like $userSys->getInfo( 'UID' )/( 'name' ); ?

[Protege]

pure rip source

a function like this is good

$userSys->getInfo( Column, Where, Return );

eg:

Receive the username for user ID 1

$userSys->getInfo( 'UserID', 1, 'Username' );

(I'll keep in your camel case)

[Mentor]

Havnt seen how the class is written but, wouldn't it make more sense to merge

$userSys->getUID()

and

$userSys->getName()

into something like $userSys->getInfo( 'UID' )/( 'name' ); ?

Hmm, i originally though having those two as separate functions would make working with it a little easier to novice users, although looking back you may have a point. Currenlty the method call for the info your after would be

$userSys->currentUser->getAttribute('uid');
or
$userSys->currentUser->getAttribute('name');


pure rip source

a function like this is good

$userSys->getInfo( Column, Where, Return );

eg:

Receive the username for user ID 1

$userSys->getInfo( 'UserID', 1, 'Username' );

(I'll keep in your camel case)
pure rip source??

Hmm, i think with that your moving more towards it simply being a layer in front of a database, which would really only service to limit what a user could normally do with SQL without really making it any easier.
Currently all database interaction is completely abstracted, the system in the demo for example is currently running on the flat file engine :)

[Source]

Care to put what you have of the class on pastie.org ? No particular reason, just intrigued into the development.

[Mentor]

Update

The Magic user system framework is going ahead as planned, I've created a project on google code to track the progress, so if your interested in this project feel free to download the current version off SVN.

http://code.google.com/p/magic-usersystem-framework/

If any of you want to get involved with this project the help would be welcomed.

Also if any designers amongst you are willing to do a little spec work it, it would be great to get a nice looking default template for the demo. Aside from simply contributing, designing a template would also give you the option to have a template by link back to your own website placed in every copy of Magic replaced :)

Changelog since last night;
] User class re abstracted, all modifications to a users profile are now handled through the user object.
] Register function completed
] Login function completed
] update profile function completed
] Fields to be used in profile can be specified in config. The profiles can be customised totally to your own likeing.
] Default profile layout updated.
- uid,name,email,dob,register_date
] Additional fields specified in config updated
- Usertitle,avatar,description,signature,postcount
] Validator class added
] Exception handler added
] None editable profile fields created

[Tomm]

If you really wanted to stay true to OOP then you should make it so that you can get a object for the user then have functions in that user class like getEmail, getTitle, etc.

[Mentor]

If you really wanted to stay true to OOP then you should make it so that you can get a object for the user then have functions in that user class like getEmail, getTitle, etc.
It is OOP? though somewhat more abstracted than your examples.

<?php
include('../Magic/magic.php');

$userSys = new UserSystem();

//get user 2 (me) (all hardcoded for example)
$userObject = $userSys->getUserInfo(2);//2 being my id

echo 'Accounts name is'.$userObject->getAttribute('name');
echo 'Accounts dob is'.$userObject->getAttribute('dob');
echo 'Accounts avatar is'.$userObject->getAttribute('avatar');

//equally if u were logged in you could get your user object via
$me= $userSys->getCurrentUser();//will be guest if not logged in
$myarray= $me->getAttributeArray();//return attributes as array

//some things are accessed via direct accessors though.
$permObj = $me->getPermissions()

//or if we wanted to we can get common options as an array via
$common = $userSys->getCurrentUserCommon();

?>

The only code outside objects at all inside magic itself is the autoloader and config import (plus an installer redirect)

[Jaysun]

I like how development is going. Also, I think I could give up some time to do some designing.

[Chippiewill]

I couldn't see a function to get the user id from the username so perhaps:

getUID($UName) To get the user id


Also a plugs system would be useful

[Mentor]

I couldn't see a function to get the user id from the username so perhaps:

getUID($UName) To get the user id


Also a plugs system would be useful

The systems a little bit early on to be thinking about plugins, although it would be a great thing to have in the long run.

Getting a user from there username is quite inefficient on the flat file db, so its reasonably well hidden. Currently you would need to make a call to the UserSystem method with the second parameter set as 'name'


$name = 'ted';
$userObj = $usrSys->getUserInfo($name, 'name');


If you think it'd be useful i could easily add a wrapper object for example getUserByName('name'); or something.

:)

@Jaysun: thanks, any inputs good :p

[timROGERS]

The systems a little bit early on to be thinking about plugins, although it would be a great thing to have in the long run.

Getting a user from there username is quite inefficient on the flat file db, so its reasonably well hidden. Currently you would need to make a call to the UserSystem method with the second parameter set as 'name'


$name = 'ted';
$userObj = $usrSys->getUserInfo($name, 'name');


If you think it'd be useful i could easily add a wrapper object for example getUserByName('name'); or something.

:)

@Jaysun: thanks, any inputs good :p

A getUserByName() functions seems reasonably sensible - the key with these framework probjects, in my view, is to make it is as easy as possible to integrate into any site in any situation.

It seems that really the best way to do that is to add as many functions as possible for accessing data, even if they do bloat the framework - the tiny difference in loading time is probably worth it...

[Tomm]

I was refering to the suggestions made by other users on how to write the system ;).

Ill just write a bit about OOP for the benifit of anyone reading this thread:

Classes should really define a single "thing" with that object having methods, typically verbs, that relate to that single thing.

Lets take a rather simple example. We're making a simple war game and we have different units. One unit might be a tank and the other might be a fighter jet. There would be two different classes for both the tank and the fighter jet e.g



class tank {
/* Functions.. blah... blah */
}

class jet {
/* Functions.... */
}


Now, the tank can fire its cannon or fire its machine guns, so we might have:



class tank {
public function fireCannon($target) {
/*code*/
}

public function fireGuns($target) {
/*code*/
}
}
Similar setup for the jet, it can fire its missiles or guns.

We would not do something like:



$army->fire("tank", "guns", 1);


Where the army object controls the entire game and just stores the data internally and each unit is identified by a ID (1 in this case). Although we might use an army object that stores the other unit objects and creates them (This is called a factory pattern).


It is OOP? though somewhat more abstracted than your examples.

<?php
include('../Magic/magic.php');

$userSys = new UserSystem();

//get user 2 (me) (all hardcoded for example)
$userObject = $userSys->getUserInfo(2);//2 being my id

echo 'Accounts name is'.$userObject->getAttribute('name');
echo 'Accounts dob is'.$userObject->getAttribute('dob');
echo 'Accounts avatar is'.$userObject->getAttribute('avatar');

//equally if u were logged in you could get your user object via
$me= $userSys->getCurrentUser();//will be guest if not logged in
$myarray= $me->getAttributeArray();//return attributes as array

//some things are accessed via direct accessors though.
$permObj = $me->getPermissions()

//or if we wanted to we can get common options as an array via
$common = $userSys->getCurrentUserCommon();

?>The only code outside objects at all inside magic itself is the autoloader and config import (plus an installer redirect)

[Mentor]

Version: 2009.05.24 v0.5.6

Changelog
# Password algorthum updated to be more secure
# getUserInfo method replaced with getUserById($id) and getUserByName($name)
# getCurrentUserCommon method removed (used volitile feilds)
# getCurrentUserInfo renamed to getAttribute
# SaveUserDetails renamed to updateCurrentUser
# updateUser Method added
# CreateUser renamed to makeNewUser
# v0.4 Mysql Database driver completed (no installer)
# More code comments added by general bug fix's
# Config altered. Install check now on path's rather than independant value.

Known issues:
#Session wondering: Session data from two differnt installs on the same server will transfer.
#Mysqls lack of zero id cause guest to need forgeing. (will need to redo how guest user is handled.)

Major features to add before first release.
#Permissions System
#Safemode option
(in safemode dangerous and possibly unwanted actions are prevented. This can be turned off by advanced users who know what they are doing and want to be able to handle issues within there own code.)
#Installer to generate config and create database's
#Demo site skin that doesnt burn peoples eyes

[Jam-ez]

Well good luck with this, on first release I'm going to hug your code and use it as a learning tool.

[Mentor]

Version: 2009.05.25 v0.5.9

Changelog

# SessionID now determined by hash (no more conflict's)
# Safemode implemented
# 4 more exceptions handled
# Additional commenting and bug fix's
# Config file reorderd and contains additonal keys
# mysql db now supports create and edit users (full functionality)
# Ability to lock profile feilds from general purpouse updates.

Known issues:


Major features still outstanding

# Installer to generate config and create database's
# Demo site skin that doesnt burn peoples eyes
# Permissions System



It wont be long before im going to need a few skilled testers to have a few goes at implementing basic user systems useing Magic to check it works? Anyone interested as the alpha isnt far off now.

Equally if anyones interested in getting involved in the project, any help would be great. Providing a nice looking skin (just html layout) for use in the projects demos would be great. Plus ideas for a logo :)

[Jam-ez]

I offer what pathetic services and skills I have, designing not included. I suppose I'm aright with ideas and I'm experienced with PHP & HTML, so I could give testing a go? (:

[Protege]

I offer what pathetic services and skills I have, designing not included. I suppose I'm aright with ideas and I'm experienced with PHP & HTML, so I could give testing a go? (:
lol no

[Jam-ez]

lol no

Don't 'lol no' me, or, y'know people in this thread will dislike you for your pointless contributions - as they do in every other thread.

Anyway, I wouldn't mind alpha testing but you're free to choose whoever.

[Protege]

dislike me :( diddoms. i think mentor can cope with coding by himself without a accidental backdoor contribution by you. stick to the testing, good boy.

[Jam-ez]

It wont be long before im going to need a few skilled testers to have a few goes at implementing basic user systems useing Magic to check it works? Anyone interested as the alpha isnt far off now.

I'm pretty sure that doesn't mean editing Magic and making back doors in it. Oh, and I never mentioned I wanted to code Magic in anyway, I am pretty sure Mentor can do it by himself, by the way.

[Protege]

soz ur rite just feelin down and pathetic atm just read a bit and didnt finish forgive me

[Jam-ez]

soz ur rite just feelin down and pathetic atm just read a bit and didnt finish forgive me

No problem? >.>
Any more updates for us Mentor? :)

[Mentor]

I've got to say this is one of the weirdest load of reply Ive read to date. Whys everyone so down? Also, due to an issue with mortality i still have to sleep occasionally and only just got up :)

Any and all contribution is welcomed, whether it be testing or helping out directly with the wirteing magic source code. Just because you can do something yourself doesn't mean you should, 2 pairs or eyes are better than one, and 2 pairs of hands definitely do the coding a bit faster :p

Even if your not interested in coding/designing directly, help with planning the release would also be great; ie forums with a community that may be interested in the project, or anything else that'll help create a bit of a buzz and actually persuade a few people to try it out.

Jaysun has kindly provided a GUI design which i'm planning to add before my next update :)

All contributions how ever small are a great help to this project, whether it be ideas for methods that would be useful or anything else. Also i want to say a big thanks to everyone thats already helped out :)

<there's also a big storm so if no updates come, the power went out>

[Source]

What does the GUI look like? Previews would be appreciated.

[Jaysun]

The GUI that I whipped up isn't the best but I'm working on it. Also I've got a logo concept of maybe a magic wand or hat or something.

[Mentor]

Look like theres not going another update for a few days, although when teh update does come its going to be a pretty big one.

If anyones interested in following the projects progress, you may want to checkout my development blog
http://userbag.co.uk/

Also @Jaysun if you come up with a nice logo, it would be great to have one for the project page. :)

[Source]

I got bored a little while ago, and made this:

http://uploadpicz.com/images/MIICLZG.jpg

Doesn't matter if you don't like, it was just messing around.

[Jam-ez]

That's really nice Source, +rep.

[Jaysun]

I got bored a little while ago, and made this:

http://uploadpicz.com/images/MIICLZG.jpg

Doesn't matter if you don't like, it was just messing around.

I love it. I was going to create one out of this:
http://vector.tutsplus.com/tutorials/illustration/how-to-create-a-magic-wand-icon/

But yours is much more original.

[Chippiewill]

Perhaps you should merge the two...

[Jaysun]

Perhaps you should merge the two...

I was thinking about that, I'll give it a shot and see how it turns out.

[Jaysun]

Sorry for the double post can someone merge?

I did a little editing to the logo above and here's what I came up with.

http://i42.tinypic.com/161x5y0.png

http://i44.tinypic.com/24wr8tu.png

http://i44.tinypic.com/1xyqop.png

http://i40.tinypic.com/5pmyr6.png

I don't really like how they turned out.

[Source]

I quite like the first one. Why dont you use the techniques you used for that and make the star glow and have the lens flare things around it?

[Jaysun]

I don't know exactly what you mean. Can you explain in further detail please =)

[Meti]

Sounds great. Maybe some more functions would be even better? :)

[Jam-ez]

I don't know exactly what you mean. Can you explain in further detail please =)

I like the designs, but hinting on what Source said, you could put the wand on the letter M, or something, and the colours behind it with a few stars around? I'm not sure - but the first one is definitely better.

[Mentor]

Wow :o Some awesome logo ideas!

Thanks for the inputs you guys, your doing great work :D
One challenge that comes here though is possibly attempting to integrate the logo (whether it be one of the above or a variant / compilation) which the default Magic template :)
But seriously, there's are all way better that I ever imagined getting :o

[Mentor]

Sorry for double post, but there is new info on project and creating another thread seems even more spammy.

Version: 2009.05.26 v0.7.4

Changelog

* Functional shift to Active Records interactions
* User object now controls db writes
* new User can be loaded direcly by creating an instance of user
* User Object can perform db writes without call to Usersystem
* User class returns shell or guest on bad id. (abstracted from UserSystem)
* User's are saved by calling write on user.
* calling write on nonexistant user will trigger new user creation
* getAttributeArray() renamed to getAsArray()
* user->getAttribute changed to user->get
* method set added: user->set(attribute, value)
* Static method User::passwordHash added.
* Database class added, loads and interacts with specific db drivers
* Database class and database drivers have been abstracted to general purpous functions
* get_row( table, colum, value)
* get_rows( table, Values_array )
* set_row( table, key_to_value_array)
* create_row( table, key_to_value_array)
* Database low level query's added (sql db's only, on flatfile will throw exception)
* query( sql )
* fetchRow()
* countRows()
* cleanString ( string )
* Signifcant enhancement to autentication systems
* Guest handling now within User class
* Shell based user creation now supported
* Securty enhancements
* Session reauthenticaed each pageload
* permission systems now implemnted
* high level querys auto-sanatise values passed to them


Known issues:
* Check for user already useing name not implemented
* Users can be created without a name.

Major features still outstanding

* Installer to generate config and create database's
* Permissions System
* flat file database no longer works. needs rewrite to work within new system

[Jam-ez]

Looking good, thanks for the update! :)

[Mentor]

@ Source and Jayson

Possibly a hard request but is it possible to change the tagline in the logos to "community site engine"

People generally read fraimwork and assume the systems somthing its not, so i though a name such as the above would help make it clear exactly what magic did. Though i can imagine issues with attempting to fit the longer sentance in to the logo :/ (heh sorry to be a diffacult customer when you guys are doing this for free, I'll be sure include you both in the credits as you guys are helping out alot :D)

[Jaysun]

I ok I see what you guys mean. I'll need the .psd from Source though before I can do that.

@Mentor
Don't worry this is giving me some practice and work to do =) Also Source has .psd for the original logo, so he may be able to change the logos tagline. I've sent you another GUI draft.

[Blob]

I as joined tha project :)

Alright peeps.

also what do u guys think is better; releasing nightly builds of magic or weekly builds? or even fortnightly or yearly lol

[Tomm]

As you don't have to compile it I don't see how you would release builds as such... guess you could provide annon SVN access though.


I as joined tha project :)

Alright peeps.

also what do u guys think is better; releasing nightly builds of magic or weekly builds? or even fortnightly or yearly lol

[Mentor]

@Tomm , right on the mark. Since the projects open source google code provide's anon SVN by defualt (read only), so downloading the latest copy is easy - although probabaly not advised. The svn copy often contains a number of bugs and may not even run without knowing what settings to tweek here and there.

Version: 2009.05.26 v0.7.6

* Permissions system added useing AR techniques
* permissions write method implented - for creation / update of permissions objects
* Partal permissions functionalty in Flatfile db (no write or update)

Known issues:

Major features still outstanding

* Installer
* Template
* Flat file completion
* General bug fix's Opermisations

Version: 2009.05.26 v0.7.5

* Bug allowing empty or used usernames fixed. function returns false in such cases
* Bug fix for createuser and updateuser usersystem methods
* Bug fix for writing blank records with FlatfileDB
* Bug fix to password hash. Was getting wrong values.

Version: 2009.05.26 v0.7.4.5

* Minor update. Flatfile Database has been upgraded to new system

[Blob]

As you don't have to compile it I don't see how you would release builds as such... guess you could provide annon SVN access though.

I meant just assure that the build is alright, because if we are working on it and someone thinks to download it and its not working, than people can get confused and a non working version?

You got a point tho

[Source]

Glad you liked it, here's a dark version of the logo for lighter backgrounds - in a PNG form.

http://uploadpicz.com/images/YXUAUVY.png

[Jaysun]

Glad you liked it, here's a dark version of the logo for lighter backgrounds - in a PNG form.

http://uploadpicz.com/images/YXUAUVY.png

I love this one, you haz 1337 photoshopz skillz!

[Dentafrice]

I meant just assure that the build is alright, because if we are working on it and someone thinks to download it and its not working, than people can get confused and a non working version?

You got a point tho
What exactly are you going to be doing?

[Meti]

The best thing for the logo is probably too keep it simple, but creative ;)

[Blob]

What exactly are you going to be doing?

Eating it.

[Mentor]

Project status Update
Just to say the lack of visable updates (commits to svn) arnt cause to worry, the projects stil steaming ahead
I've put together a roadmap of project updates;

http://code.google.com/p/magic-usersystem-framework/wiki/Roadmap

Major commits etc will appear on those version numbers. Changelogs for unreleaced versions for those interested;

Version: 2009.05.26 v0.7.8

* flatfile db development halted, focusing on sql db system first.
* PMsystem object added (used to send/receave personal message's)
* get_rowcount and remove_row functions added to Database
* Where parameter added to get_rows, takes a keyed array (can be left blank)
* Small bugfix's
* Basic documention + roadmap
* Drafted Demo template's based off concept work of jayson

Outstanding features

* Flatfile Db system (needs general purpseing redesign)
* Installer
* Template
* Documention

Version: 2009.05.26 v0.7.7

* Permission system write method added for flat files.
* Minor bug fix's



@Blob, Great to hear your interested in getting involved? Drop me a PM which what aspect you wana get involved with, codeing, testing, documention, designing etc :)

[BoyBetterKnow]

Sorry if this is a bump or whatnot, I've only just joined.

My idea is that when using getName(), by default if they're not logged in it returns guest. How about a parameter allowing the coder to choose what to display. For instance.

getName('Unregistered Habbo');

If that's not set then by default guest. Just something Habbo users might want...

ONCE AGAIN, Sorry if I have "bumped".

[Dentafrice]

Sorry if this is a bump or whatnot, I've only just joined.

My idea is that when using getName(), by default if they're not logged in it returns guest. How about a parameter allowing the coder to choose what to display. For instance.

getName('Unregistered Habbo');

If that's not set then by default guest. Just something Habbo users might want...

ONCE AGAIN, Sorry if I have "bumped".
Why not just have a setting in the configuration for the 'Unregistered Habbo', because multiple calls to getName would get really confusing if you ever decided to change 'Unregistered Habbo'.

[BoyBetterKnow]

Why not just have a setting in the configuration for the 'Unregistered Habbo', because multiple calls to getName would get really confusing if you ever decided to change 'Unregistered Habbo'.

Good point :) Your way's better.

[Mentor]

This kind of already exists. When a call is made to getname of an unregisterd user, the guest name (which is set within the config) is returned.

So changeing the guest_name value in the config will get you the result your after :)

[Chippiewill]

Well, with HxF being down all day I was extremely bored all day, and since I remembered Mentor asking for a 'Community Forum' in the middle of the thread, I thought of nothing better than to make an overmodded phpbb3 forum :D.

http://magicengine.uk.to/community/ :P Unfortunatly evaske is down atm, again. However I managed to track downvery good looking user rank images which is very hard with phpbb3 (People at phpbb3 mostly code, not design). Oh and I even put on TweetBoard for no reason...

[Jaysun]

It's down for me =(

[Chippiewill]

Yes because the host is down... -.- read it through please :rolleyes:. It was quite funny, I subscribed for the free forum thing and they just gave me plain old cpanel access xD, it's a big package aswell...

[Jaysun]

:eusa_wall

My bad. Good job on setting up a forum though.

[Chippiewill]

Here's a live demo of the theme I'm using atm so you can see what it'll be like:

http://www.phpbb.com/styles/demo/3.0/index.php?style_id=3

[Chippiewill]

Thar site be back-up now :D, I just need to quickly edit the magic logo and that'll be up any minute now :D

Edit: Just realised I screwed up the guest settings on the forums :P

[Chippiewill]

Bah, the logo is to big...